update the docs

code4game · Oct 12, 2020 · 33a25d4 · 33a25d4
1 parent 15e35fc
commit 33a25d4
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,7 +7,9 @@ Welcome to libgltf's documentation!
 ===================================
 
 |glTF 2.0| |docs| |visit-milstones|
+
 |travis-ci| |appveyor-ci|
+
 |coveralls| |codacy| |bestpractices|
 
 This project was generated by glTF 2.0 JSON schema and support to load the glTF 2.0 file to a struct `SGlTF`.
@@ -51,7 +53,7 @@ Getting Started
 5. Link the static library `libgltf.lib` or `libgltf.a` in your project.
 
    ..
-
+   
       You have to link the static library `draco.lib` or `draco.a` with your project, if you want support the `Google's Draco`_.
       And you can find the draco in the external folder.
 
@@ -147,10 +149,11 @@ Supports Google's draco
 
 You can update the Google's draco submodule in external/draco or pull the draco repo by yourself.
 
-Set the `GOOGLE_DRACO_PATH_INCLUDE`, `GOOGLE_DRACO_PATH_BUILD`, `GOOGLE_DRACO_LIBRARY_DRACODEC_DEBUG`, `GOOGLE_DRACO_LIBRARY_DRACODEC_RELEASE`, `GOOGLE_DRACO_LIBRARY_DRACOENC_DEBUG` and `GOOGLE_DRACO_LIBRARY_DRACOENC_RELEASE`.
-
 Check the `LIBGLTF_USE_GOOGLE_DRACO` or set `LIBGLTF_USE_GOOGLE_DRACO` is `TRUE`.
 
+* Set the `GOOGLE_DRACO_PATH_INCLUDE`, `GOOGLE_DRACO_PATH_BUILD`, `GOOGLE_DRACO_LIBRARY_DRACODEC_DEBUG`, `GOOGLE_DRACO_LIBRARY_DRACODEC_RELEASE`, `GOOGLE_DRACO_LIBRARY_DRACOENC_DEBUG` and `GOOGLE_DRACO_LIBRARY_DRACOENC_RELEASE`.
+* Or enable the `LIBGLTF_USE_GOOGLE_DRACO_SUBMODULE` to compile with the submodule - `external/draco`.
+
 
 Donation
 ==============================================================