prepare for merging doc into mono-repository

This commit is contained in:
2021-03-25 17:06:29 +01:00
parent daec8c892c
commit d9759024ef
68 changed files with 0 additions and 0 deletions

26
docs/README.md Normal file
View File

@@ -0,0 +1,26 @@
Chill documentation
====================
Documentation of the Chill software.
The compiled documentation may be read at http://docs.chill.social
Compilation into HTML
=====================
To compile this documentation :
1. Install [sphinx-doc](http://sphinx-doc.org) (eg. pip install sphinx & pip install sphinx_rtd_theme)
2. Install submodules : $ git submodule update --init;
3. run `make html` from the root directory
4. The base file is located on build/html/index.html
Contribute
===========
Issue tracker : https://git.framasoft.org/groups/Chill-project/issues
Licence
=======
This documentation is available under the [GNU Free Documentation Licence](http://www.gnu.org/licenses/fdl-1.3.en.html).