Skip to content

Commit 3a969a4

Browse files
author
Devyn Stott
committed
docs(): Add some basic stud documentation
1 parent 99015af commit 3a969a4

3 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,10 @@ A starting spot for python projects. Embracing open source elements.
55

66
This project follows the structure suggested in [Jan-Philip Gehrcke's Blog](https://gehrcke.de/2014/02/distributing-a-python-command-line-application/).
77

8+
# Project Versioning
9+
10+
This project uses [Semver](http://semver.org/) as its versioning scheme.
11+
12+
# Project Tests
13+
14+
Basic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`.

docs/Overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Overview
2+
3+
This is the project overview

docs/UserGuide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# User Guide
2+
3+
This is the user guide.

0 commit comments

Comments
 (0)