From fc2d6441596e547ba8d8c9957b092724d8bb9ae3 Mon Sep 17 00:00:00 2001
From: jwansek <eddie.atten.ea29@gmail.com>
Date: Thu, 28 Apr 2022 17:52:47 +0100
Subject: Started writing documentation

---
 docs/source/index.rst | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 docs/source/index.rst

(limited to 'docs/source/index.rst')

diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..c238253
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,34 @@
+Welcome to Smarker's documentation!
+===================================
+
+Setting up
+----------
+
+* Set up a MySQL/MariaDB server. The database will be generated automatically.
+* Add ``smarker.conf`` to the root directory of the code. See :ref:`configfile` for the structure of this file.
+* Decide how you want to run the program: with or without docker.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Modules:
+   
+   reflect.rst
+   database.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Other Pages:
+
+   configfile.rst
+   docker.rst
+
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
-- 
cgit v1.2.3