-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |