2
0
mirror of https://github.com/carlostrub/sisyphus synced 2024-10-31 09:20:15 +00:00

update initial docs

This commit is contained in:
Carlo Strub 2017-03-08 08:23:38 +00:00
parent 0f27b155f6
commit 18cb0c1b57
3 changed files with 42 additions and 8 deletions

View File

@ -1,3 +0,0 @@
# Sisyphus
Hello to the documentation on Sisyphus. More to come...

41
docs/index.rst Normal file
View File

@ -0,0 +1,41 @@
Sisyphus
========
$project will solve your problem of where to start with documentation,
by providing a basic explanation of how to do it easily.
Look how easy it is to use:
import project
# Get your stuff done
project.do_stuff()
Features
--------
- Be awesome
- Make things faster
Installation
------------
Install $project by running:
install project
Contribute
----------
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
The project is licensed under the BSD license.

View File

@ -1,8 +1,4 @@
site_name: Sisyphus Documentation site_name: Sisyphus Documentation
pages: pages:
- Home: index.md - Home: index.rst
- Getting Started: getting-started.md
- Versions and Ranges: versions.md
- Commands: commands.md
- F.A.Q.: faq.md
theme: readthedocs theme: readthedocs