From ea249be466cbe1f935102eda441e1a70045b58eb Mon Sep 17 00:00:00 2001 From: AR Date: Fri, 31 Oct 2025 21:12:12 +0500 Subject: [PATCH] Made the README more tidy & fix Build.md (#6371) * Update LICENSE * Update Preamble.txt * Update SECURITY.md * Remove GitHub's default comment * Better README! * Fix discord link! Boom, that's how it's done * Fixed itch.io spelling from itchi.io * Make README more tidy :) AR is back! Anyways, I'm working on my horror game & making devlogs so I don't have time to write. Here's a small summary: - Just placed the dir structure information correctly in one place so the README looks tidy. * Add international download link for Visual Studio --- Build.md | 2 +- Readme.md | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Build.md b/Build.md index f7bff12f5..7baca6df2 100644 --- a/Build.md +++ b/Build.md @@ -30,7 +30,7 @@ cmake --build . Note that by default this builds a shared library into the `bin` directory. If you want to build it as a static library see the build options at the bottom of this file. ### Build instructions for Windows with Visual-Studio -First, you have to install Visual-Studio on your windows-system. You can get the Community-Version for free here: https://visualstudio.microsoft.com/de/downloads/ +First, you have to install Visual-Studio on your windows-system. You can get the Community-Version for free [here](https://visualstudio.microsoft.com/downloads/) To generate the build environment for your IDE open a command prompt, navigate to your repo and type: ```bash cmake CMakeLists.txt diff --git a/Readme.md b/Readme.md index 344418602..e0fc61b84 100644 --- a/Readme.md +++ b/Readme.md @@ -64,7 +64,7 @@ Open Asset Import Library is implemented in C++. The directory structure looks l /code Source code /contrib Third-party libraries /doc Documentation (Doxygen source and pre-compiled docs) - /fuzz Contains the test code for the Google Fuzzer project + /fuzz Contains the test code for the Google Fuzzer project /include Public header C and C++ header files /scripts Scripts are used to generate the loading code for some formats /port Ports to other languages and scripts to maintain those. @@ -74,12 +74,12 @@ Open Asset Import Library is implemented in C++. The directory structure looks l The source code is organized in the following way: - code/Common The base implementation for importers and the infrastructure - code/CApi Special implementations which are only used for the C-API - code/Geometry A collection of geometry tools - code/Material The material system - code/PBR An exporter for physical-based models - code/PostProcessing The post-processing steps + code/Common The base implementation for importers and the infrastructure + code/CApi Special implementations which are only used for the C-API + code/Geometry A collection of geometry tools + code/Material The material system + code/PBR An exporter for physical-based models + code/PostProcessing The post-processing steps code/AssetLib/ Implementation for import and export of the format ### Contributing ###