Add some installation instructions.

bluescarni · May 21, 2024 · b6710a1 · b6710a1
1 parent 73f57ab
commit b6710a1
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -28,6 +28,7 @@ default implementations, single/multiple inheritance, etc.) with C++20 concepts.
 .. toctree::
    :maxdepth: 1
 
+   installation.rst
    tutorials.rst
    case_studies.rst
    api_reference.rst
diff --git a/doc/installation.rst b/doc/installation.rst
@@ -0,0 +1,18 @@
+Installation
+============
+
+tanuki currently consists of a self-contained single header, with no dependencies
+apart from the standard library. Just grab the ``include/tanuki.hpp`` header and copy it
+somewhere in your project.
+
+Supported platforms/compilers
+-----------------------------
+
+tanuki requires a C++ compiler with decent support for several C++20 features.
+Currently the following compilers are tested in the CI pipeline:
+
+- GCC >= 10.4,
+- clang >= 14,
+- MSVC 2022.
+
+The CI pipeline is run on several platforms, including x86-64/arm64 Linux, x86-64 OSX and Windows.