Update README

This commit is contained in:
Andrea Mistrali 2023-05-02 13:28:41 +02:00
parent 1a2c2ae67c
commit e61c3bb78f
No known key found for this signature in database
GPG Key ID: 6FB0A77F6D5DA9B2
1 changed files with 18 additions and 0 deletions

View File

@ -1,3 +1,21 @@
# Pulses # Pulses
Pulses is a python module to drive LEDs on RPi using PWM (Pulse Width Modulation) 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.