Refine README

master
Tanner Collin 4 years ago
parent b40ca07f35
commit cbb5a360b9
  1. 9
      README.md

@ -4,20 +4,21 @@ Door controller for scanning Protospace member cards on the front and back doors
## Setup ## Setup
Ensure Pi user has read permissions to /dev/ttyACM0. Ensure Pi user has read permissions to /dev/ttyACM0 (Pi user needs to be part of the dialout group).
Install dependencies: Install dependencies:
```text ```text
$ sudo apt update $ sudo apt update
$ sudo apt install python3 python3-pip python-virtualenv python3-virtualenv $ sudo apt install python3 python3-pip python-virtualenv python3-virtualenv supervisor
``` ```
Clone this repo: Clone this repo:
```text ```text
$ git clone https://github.com/Protospace/airlock.git $ git clone https://github.com/Protospace/airlock.git
$ cd airlock $ sudo mv airlock/ /opt/
$ cd /opt/airlock
``` ```
### Watchdog ### Watchdog
@ -49,7 +50,7 @@ Start an empty card_data.json:
Now you can run the script to test: Now you can run the script to test:
```text ```text
(env) $ python main.py (env) $ DEBUG=true python main.py
``` ```
## Process management ## Process management

Loading…
Cancel
Save