Skip to content

Commit 7b5a1b9

Browse files
author
Devyn Stott
committed
docs(README): Add some explination of the build system
1 parent f76256e commit 7b5a1b9

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,24 @@ A starting spot for python projects. Embracing open source elements.
44
[![Documentation status](https://readthedocs.org/projects/python-starter/badge/?version=latest)](http://python-starter.readthedocs.io/en/latest/) [![Build Status](https://travis-ci.org/SyntaxRules/python-starter.svg?branch=master)](https://travis-ci.org/SyntaxRules/python-starter) [![codecov](https://codecov.io/gh/SyntaxRules/python-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/SyntaxRules/python-starter)
55

66

7-
# Project Structure
7+
# Project Details
8+
9+
## Structure
810

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

11-
# Project Versioning
13+
## Versioning
1214

1315
This project uses [Semver](http://semver.org/) as its versioning scheme.
1416

15-
# Project Tests
17+
## Tests.
18+
19+
Basic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`. The unit tests are in line with the code. You can run all the tests with `python -m pytest .`.
20+
21+
The tests are ran automatically when they are submitted to github via [travici.org](https://travis-ci.org/SyntaxRules/python-starter). Your tests must work here to be considered passing, it doesn't matter if they run on your local machine, if they fail on TravisCI, then they will not be accepted into matser.
22+
23+
Coverage is also determined by TravisCI and reported to [CodeCov](https://codecov.io/gh/SyntaxRules/python-starter).
24+
25+
## Documentation
1626

17-
Basic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`.
27+
Documentation is inline (like unit tests) and deployed with [Read the Docs](http://python-starter.readthedocs.io/en/latest/). When editing code, please include documentation for your changes. Add any new files to the `mkdocs.yml` file. The documentation is automatically built and installed.

starter/docs/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)