add readme
This commit is contained in:
25
README.md
25
README.md
@@ -1,2 +1,27 @@
|
||||
# flask-beertap
|
||||
|
||||
## How to run
|
||||
|
||||
If you want a production environment set up your `.env` to provide an app key.
|
||||
|
||||
```python
|
||||
pipenv install
|
||||
pipenv run python main.py
|
||||
chromium-browser 127.0.0.1:5000
|
||||
```
|
||||
|
||||
## gpio handler
|
||||
|
||||
Takes care of the needed raspberry pi gpio functions.
|
||||
|
||||
```python
|
||||
from gpio_handler import create_output
|
||||
|
||||
out = create_output()
|
||||
out.gpio_test()
|
||||
out.gpio_set_pulse(channel=1, time_on=2)
|
||||
```
|
||||
|
||||
## Author
|
||||
|
||||
Aaron Schmocker <schmocker@puzzle.ch>
|
||||
|
||||
Reference in New Issue
Block a user