Add setup.py and distribution basics

This commit is contained in:
Ben Nuttall
2015-09-15 17:53:50 +01:00
parent abdc215175
commit a8b93cf97f
11 changed files with 102 additions and 173 deletions

22
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,22 @@
# Contributing
This module was designed for use in education; particularly for young children. It is not intended to replace `RPi.GPIO` and it does not claim to be suitable for all purposes. It is intended to provide a simple interface to everyday components.
If a proposed change added an advanced feature but made basic usage more complex, it is unlikely to be added.
## Suggestions
Please make suggestions by opening an [issue](https://github.com/RPi-Distro/gpio-zero/issues) explaining your reasoning clearly.
## Bugs
Please submit bug reports by opening an [issue](https://github.com/RPi-Distro/gpio-zero/issues) explaining the problem clearly using code examples.
## Documentation
The documentation source lives in the [docs](https://github.com/RPi-Distro/gpio-zero/tree/master/docs) folder and is rendered from markdown into HTML using [mkdocs](http://www.mkdocs.org/). Contributions to the documentation are welcome but should be easy to read and understand.
## Python
- Python 2/3 compatibility
- PEP8-compliance (with exceptions)