diff --git a/README.md b/README.md index 8d24eaf..135ae7f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # Pulses Pulses is a python module to drive LEDs on RPi using PWM (Pulse Width Modulation) + + +### INSTALL + +1. Clone the repo + + `git clone https://web.mistrali.pw/gitea/musicalbox/pulses.git` + +2. `apt-get install python3-venv` +3. `pip install requirements-dev.txt` +4. `./build.sh` +5. `pip install dist/pulses-0.90-py3-none-any.whl` + + +### CLI tool + +There is a CLI tool, called `pulses` that you can use to test loops and pulses. +Run `pulses -h` to read the usage instructions.