Skip to content

Commit

Permalink
Add docs with Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
cclauss committed Sep 4, 2024
1 parent 23ecca2 commit 398782b
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
$project
========

$project solves the problem of where to start with documentation
by providing a basic explanation of how to do it easily:

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/ISKME/$project/issues
- Source Code: github.com/ISKME/$project

Support
-------

Please open an issue in our [Issue Tracker](github.com/ISKME/$project/issues).

License
-------

The project is licensed under the BSD license.

0 comments on commit 398782b

Please sign in to comment.