docs: add getting started section
This commit is contained in:
25
README.md
25
README.md
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user