浏览代码

Update Build.md

Some doc improvements.
Kim Kulling 6 年之前
父节点
当前提交
396b518ecb
共有 1 个文件被更改,包括 24 次插入22 次删除
  1. 24 22
      Build.md

+ 24 - 22
Build.md

@@ -1,5 +1,5 @@
 # Install CMake
-Asset-Importer-Lib supports a lot of different OSes and platforms. We are using cmake to generate the build environment for these via cmake. So you have to make sure that you have a working cmake-installation on your system. You can download it at https://cmake.org/
+Asset-Importer-Lib can be buildfor a lot of different OS'es and platforms. We are using cmake to generate the build environment for these via cmake. So you have to make sure that you have a working cmake-installation on your system. You can download it at https://cmake.org/
 
 # Get the source
 Make sure you have a working git-installation. Open a command prompt and clone the Asset-Importer-Lib via:
@@ -22,33 +22,35 @@ See https://stackoverflow.com/questions/40803170/cmake-uwp-using-cmake-to-build-
 
 
 # Build instrcutions for Linux / Unix
-Open a terminal and got to your repository. You can generate the projectfiles and build the library via:
+Open a terminal and got to your repository. You can generate the makefiles and build the library via:
 
 ```
 cmake CMakeLists.txt
 make -j4
 ```
-The option -j descripes the number of parallel processes for the build.
+The option -j descripes the number of parallel processes for the build. In this case make will try to use 4 cores for the build.
+
+If you want to use a IDE for linux you can try QTCreator for instance. 
 
 # CMake build options
 The cmake-build-environment provides options to configure the build. The following options can be used:
-- BUILD_SHARED_LIBS ( default ON ): Generation of shared libs ( dll for windows, so for Linux ). Set this to OFF to get a static lib.
-- BUILD_FRAMEWORK ( default OFF, MacOnly): Build package as Mac OS X Framework bundle
-- ASSIMP_DOUBLE_PRECISION( default OFF ): All data will be stored as double values.
-- ASSIMP_OPT_BUILD_PACKAGES ( default OFF): Set to ON to generate CPack configuration files and packaging targets
-- ASSIMP_ANDROID_JNIIOSYSTEM ( default OFF ): Android JNI IOSystem support is active
-- ASSIMP_NO_EXPORT ( default OFF ): Disable Assimp's export functionality
-- ASSIMP_BUILD_ZLIB ( default OFF ): Build your own zlib
-- ASSIMP_BUILD_ASSIMP_TOOLS ( default ON ): If the supplementary tools for Assimp are built in addition to the library.
-- ASSIMP_BUILD_SAMPLES ( default OFF ): If the official samples are built as well (needs Glut).
-- ASSIMP_BUILD_TESTS ( default ON ): If the test suite for Assimp is built in addition to the library.
-- ASSIMP_COVERALLS ( default OFF ): Enable this to measure test coverage.
-- ASSIMP_WERROR( default OFF ): Treat warnings as errors.
-- ASSIMP_ASAN ( default OFF ): Enable AddressSanitizer.
-- ASSIMP_UBSAN ( default OFF ): Enable Undefined Behavior sanitizer.
-- SYSTEM_IRRXML ( default OFF ): Use system installed Irrlicht/IrrXML library.
-- BUILD_DOCS ( default OFF ): Build documentation using Doxygen.
-- INJECT_DEBUG_POSTFIX( default ON ): Inject debug postfix in .a/.so lib names
-- IGNORE_GIT_HASH ( default OFF ): Don't call git to get the hash.
-- ASSIMP_INSTALL_PDB ( default ON ): Install MSVC debug files.
+- **BUILD_SHARED_LIBS ( default ON )**: Generation of shared libs ( dll for windows, so for Linux ). Set this to OFF to get a static lib.
+- **BUILD_FRAMEWORK ( default OFF, MacOnly)**: Build package as Mac OS X Framework bundle
+- **ASSIMP_DOUBLE_PRECISION( default OFF )**: All data will be stored as double values.
+- **ASSIMP_OPT_BUILD_PACKAGES ( default OFF)**: Set to ON to generate CPack configuration files and packaging targets
+- **ASSIMP_ANDROID_JNIIOSYSTEM ( default OFF )**: Android JNI IOSystem support is active
+- **ASSIMP_NO_EXPORT ( default OFF )**: Disable Assimp's export functionality
+- **ASSIMP_BUILD_ZLIB ( default OFF )**: Build your own zlib
+- **ASSIMP_BUILD_ASSIMP_TOOLS ( default ON )**: If the supplementary tools for Assimp are built in addition to the library.
+- **ASSIMP_BUILD_SAMPLES ( default OFF )**: If the official samples are built as well (needs Glut).
+- **ASSIMP_BUILD_TESTS ( default ON )**: If the test suite for Assimp is built in addition to the library.
+- **ASSIMP_COVERALLS ( default OFF )**: Enable this to measure test coverage.
+- **ASSIMP_WERROR( default OFF )**: Treat warnings as errors.
+- **ASSIMP_ASAN ( default OFF )**: Enable AddressSanitizer.
+- **ASSIMP_UBSAN ( default OFF )**: Enable Undefined Behavior sanitizer.
+- **SYSTEM_IRRXML ( default OFF )**: Use system installed Irrlicht/IrrXML library.
+- **BUILD_DOCS ( default OFF )**: Build documentation using Doxygen.
+- **INJECT_DEBUG_POSTFIX( default ON )**: Inject debug postfix in .a/.so lib names
+- **IGNORE_GIT_HASH ( default OFF )**: Don't call git to get the hash.
+- **ASSIMP_INSTALL_PDB ( default ON )**: Install MSVC debug files.