Skip to content

Commit

Permalink
Update quickstart.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kimkulling authored Jul 31, 2023
1 parent 85b0b8d commit 8f57f82
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions source/about/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand All @@ -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 <https://github.com/assimp/assimp/issues>`_. Alternatively, there's
a mailing list, `assimp-discussions <https://github.com/assimp/assimp/discussions>`_
`Github-Issue-Tracker <https://github.com/assimp/assimp/issues>`_.
Alternatively, there's was a mailing list, `assimp-discussions <https://github.com/assimp/assimp/discussions>`_ .
This one is deprecated. Try to use `Assimp on Stackoverflow <https://stackoverflow.com/questions/tagged/assimp>`_ or
`Assimp on Reddit <https://www.reddit.com/r/Assimp/>`_ instead.
.

.. _ai_install_prebuilt:
Expand All @@ -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-&gt;Extras-&gt;Options-&gt;Projects and Solutions-&gt;VC++ Directories-&gt;Include files)
and the assimp/lib/&lt;Compiler&gt; path to your linker paths (Menu-&gt;Extras-&gt;Options-&gt;Projects and Solutions-&gt;VC++ Directories-&gt;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:

::

Expand All @@ -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 <https://github.com/Microsoft/vcpkg/>`_ dependency manager:
You can download and install **Assimp** using the `vcpkg <https://github.com/Microsoft/vcpkg/>`_ dependency manager:
::

bash
Expand All @@ -71,16 +73,16 @@ You can download and install assimp using the `vcpkg <https://github.com/Microso
./vcpkg integrate install
vcpkg install assimp

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 <reate an issue or pull request on the `vcpkg repository <https://github.com/Microsoft/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 <reate an issue or pull request on the `vcpkg repository <https://github.com/Microsoft/vcpkg>`_ .


.. _ai_install_own:

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:

::

Expand Down Expand Up @@ -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 <https://github.com/taka-no-me/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:

::

Expand All @@ -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.

0 comments on commit 8f57f82

Please sign in to comment.