diff --git a/source/about/quickstart.rst b/source/about/quickstart.rst index 9406801..d2fabfe 100644 --- a/source/about/quickstart.rst +++ b/source/about/quickstart.rst @@ -5,8 +5,8 @@ Data Structures --------------- When the importer successfully completed its job, the imported data is returned in an aiScene structure. This is the root -point from where you can access all the various data types that a scene/model file can possibly contain. The -:ref:`ai_data` describes how to interpret this data. +point from where you can access all the various data types that a scene/model file can possibly contain. +The:ref:`ai_data` describes how to interpret this data. .. _ai_ext: @@ -15,8 +15,8 @@ Extending the library There are many 3d file formats in the world, and we're happy to support as many as possible. If you need support for a particular file format, why not implement it yourself and add it to the library? Writing importer plugins for -assimp is considerably easy, as the whole postprocessing infrastructure is available and does much of the work for you. -See the :ref:`ai_extend` extend Extending the library page for more information. +**Assimp** is considerably easy, as the whole postprocessing infrastructure is available and does much of the work for you. +See the:ref:`ai_extend` extend Extending the library page for more information. .. _ai_main_support: @@ -25,8 +25,10 @@ Support & Feedback ------------------ If you have any questions/comments/suggestions/bug reports you're welcome to post them in our -`Github-Issue-Tracker `_. Alternatively, there's -a mailing list, `assimp-discussions `_ +`Github-Issue-Tracker `_. +Alternatively, there's was a mailing list, `assimp-discussions `_ . +This one is deprecated. Try to use `Assimp on Stackoverflow `_ or +`Assimp on Reddit `_ instead. . .. _ai_install_prebuilt: @@ -35,19 +37,19 @@ Using the pre-built libraries with Visual-Studio ------------------------------------------------ If you develop at Visual Studio 2015, 2017, 2019, or 2022 you can simply use the pre-built linker libraries provided in the distribution. -Extract all files to a place of your choice. A directory called "assimp" will be created there. Add the **assimp/include** path +Extract all files to a place of your choice. A directory called **Assimp** will be created there. Add the **assimp/include** path to your include paths (Menu->Extras->Options->Projects and Solutions->VC++ Directories->Include files) and the assimp/lib/<Compiler> path to your linker paths (Menu->Extras->Options->Projects and Solutions->VC++ Directories->Library files). This is necessary only once to set up all paths inside your IDE. -To use the library in your C++ project you can simply generate a project file via cmake. One way is to add the assimp-folder -as a subdirectory via the cmake-command +To use the library in your C++ project you can simply generate a project file via cmake. One way is to add the **Assimp** folder +as a subdirectory via the cmake-command: :: ADD_SUBDIRECTORY(assimp) -Now just add the assimp-dependency to your application: +Now just add the **Assimp** dependency to your application: :: @@ -61,7 +63,7 @@ If done correctly you should now be able to compile, link, run, and use the appl Build on all platforms using vcpkg ---------------------------------- -You can download and install assimp using the `vcpkg `_ dependency manager: +You can download and install **Assimp** using the `vcpkg `_ dependency manager: :: bash @@ -71,7 +73,7 @@ You can download and install assimp using the `vcpkg `_ . +The **Assimp** port in **vcpkg** is kept up to date by Microsoft team members and community contributors. If the version is out of date, please `_ . .. _ai_install_own: @@ -79,8 +81,8 @@ The assimp port in vcpkg is kept up to date by Microsoft team members and commun Building the library from scratch --------------------------------- -First, you need to install cmake. Now just get the code from github or download the latest version from the website. -to build the library just open a command-prompt / bash, navigate into the repo folder and run cmake via: +First, you need to install **cmake**. Now just get the code from GitHub or download the latest version from the website. +to build the library just open a command-prompt / bash, navigate into the repo folder, and run **cmake** via: :: @@ -121,20 +123,20 @@ an Android-native application. - It requires Android NDK with Android API > 9 support. - Building: -To use this module please provide the following cmake defines: +To use this module please provide the following **cmake** defines: :: -DASSIMP_ANDROID_JNIIOSYSTEM=ON -DCMAKE_TOOLCHAIN_FILE=$SOME_PATH/android.toolchain.cmake -**SOME_PATH** is the path containing your cmake android-toolchain script. +**SOME_PATH** is the path containing your **cmake** android-toolchain script. The build script for this port is based on `Android-CMake `_. -See its documentation for more Android-specific cmake options (e.g. **-DANDROID_ABI** for the target ABI). +See its documentation for more Android-specific **cmake** options (e.g. **-DANDROID_ABI** for the target ABI). - Code-Example: -A small example of how to wrap assimp for Android: +A small example of how to wrap **Assimp** for Android: :: @@ -146,4 +148,4 @@ A small example of how to wrap assimp for Android: importer->SetIOHandler(ioSystem); } -The Assimp-package can be built as DLL. You just need to run the default cmake run. +The Assimp-package can be built as DLL. You just need to run the default **cmake** run.