summaryrefslogtreecommitdiff
path: root/libs/cglm/docs/source/index.rst
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-06-14 00:06:42 -0500
committersanine <sanine.not@pm.me>2022-06-14 00:06:42 -0500
commit2f518e5e28d35ae24a5ac0e31000835e43b01972 (patch)
tree47fdeb9fa5b04e267702acb06424d3f87b37dd84 /libs/cglm/docs/source/index.rst
parent034d5c965ff34cfdf4b153af9f32360a02e35684 (diff)
add cglm as 3rd-party library
Diffstat (limited to 'libs/cglm/docs/source/index.rst')
-rw-r--r--libs/cglm/docs/source/index.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/libs/cglm/docs/source/index.rst b/libs/cglm/docs/source/index.rst
new file mode 100644
index 0000000..34a71c4
--- /dev/null
+++ b/libs/cglm/docs/source/index.rst
@@ -0,0 +1,53 @@
+.. cglm documentation master file, created by
+ sphinx-quickstart on Tue Jun 6 20:31:05 2017.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+cglm Documentation
+================================
+
+**cglm** is an optimized 3D math library written in C99 (compatible with C89).
+It is similar to the original **glm** library, except **cglm** is mainly for
+**C**.
+
+**cglm** stores matrices as column-major order but in the future row-major is
+considered to be supported as optional.
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Getting Started:
+
+ features
+ build
+ getting_started
+
+.. toctree::
+ :maxdepth: 2
+ :caption: How To:
+
+ opengl
+
+.. toctree::
+ :maxdepth: 2
+ :caption: API:
+
+ api
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Options:
+
+ opt
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Troubleshooting:
+
+ troubleshooting
+
+Indices and Tables:
+===================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`