docs: add getting started section

This commit is contained in:
Himadri Bhattacharjee
2026-01-10 12:38:48 +05:30
parent 537fc14365
commit 108c64b65e

View File

@@ -14,3 +14,28 @@ Unlatched | Whenever | Latched
Latched | < 500ms | Locked
Latched | >= 500ms | Unlatched
Locked | Whenever | Unlatched
## Getting Started
### Build
```sh
cargo build --release
```
Optionally place the binary in /usr/local/bin/
```sh
mkdir -p /usr/local/bin
cp ./target/release/lollipop /usr/local/bin/lollipop
```
### Run
```sh
sudo lollipop || sudo ./target/release/lollipop
```
## Systemd service
Coming soon