summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
authorDanny Holman <dholman@gymli.org>2024-10-25 01:49:29 -0500
committerDanny Holman <dholman@gymli.org>2024-10-25 01:49:29 -0500
commite38d94416f705aa4ddd32e1c51199b45b58d6093 (patch)
tree88f19d0f17aed3ff5004d28d7c4fa49e28ad08b8 /doc/index.rst
parent28e27060274591fe13d5a1a226216fb01141e2f7 (diff)
doc: add introductory documentation files
Add documentation files that act as the starting points for the rest of the documentation and introduce a beginner to Rune. Signed-off-by: Danny Holman <dholman@gymli.org>
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..b4dfb5a
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,46 @@
+.. Rune Game Engine documentation master file, created by
+ sphinx-quickstart on Wed Oct 16 23:36:04 2024.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Rune Game Engine documentation
+==============================
+
+Rune is a high-performance game engine written entirely in C and designed to
+support Quake-style, "boomer" shooters. It is free and open source, and has both
+2D and 3D capabilities. If you are new to this documentation, we recommend that
+you read the `introduction page <introduction.html>`_ to get an overview of features and specs that
+Rune has to offer. Please note that improvements to the documentation are
+welcome; join the rune-engine mailing list at lists.gymli.org if you want to help
+out.
+
+User-oriented documentation
+---------------------------
+
+The following manuals are written for game or application developers who are
+trying to get the engine to work for their own applications or libraries.
+
+.. toctree::
+ :maxdepth: 1
+
+ Introduction <introduction.rst>
+ List of features <feature-list.rst>
+ Core API <core/index.rst>
+ Network API <network/index.rst>
+ Rendering API <render/index.rst>
+ UI API <ui/index.rst>
+ Sound API <sound/index.rst>
+ Reporting issues <reporting-issues.rst>
+
+Working with upstream
+---------------------
+
+The guides for interacting with the engine's development community and getting
+your work upstream.
+
+.. toctree::
+ :maxdepth: 1
+
+ Development process <dev-process.rst>
+ Coding style <coding-style.rst>
+ Submitting patches <submitting-patches.rst>