Browse Source

added template index.rst and wrote a description about digilib in index.rst

digital 4 years ago
parent
commit
64a77ec34f
2 changed files with 65 additions and 4 deletions
  1. 10 4
      src/docs/index.rst
  2. 55 0
      src/docs/templates/index.rst

+ 10 - 4
src/docs/index.rst

@@ -19,11 +19,17 @@
 
 
 
-Welcome to BeeWatch's documentation!
-====================================
+Welcome to DigiLib's documentation!
+===================================
 
-.. Note::
-    This documentation is in early development.
+DigiLib is a library which contains generally useful code. Having it in a separate library allows me to easily use it in my projects.
+
+..  Note::
+    This project is very experimental. I do not advise you to use it yet.
+    The documentation is incomplete, so don't wonder about strange stuff.
+
+..  Warning::
+    You loose the game.
 
 .. toctree::
    :maxdepth: 2

+ 55 - 0
src/docs/templates/index.rst

@@ -0,0 +1,55 @@
+..  Note
+    Copyright 2017 Digital
+
+    This file is part of DigiLib.
+
+    DigiLib is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    DigiLib is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with DigiLib.  If not, see <http://www.gnu.org/licenses/>.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Template
+==============
+
+Template text.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+..