From 108c64b65e2aa47ea08d445d85c61fdbcf0e2e62 Mon Sep 17 00:00:00 2001 From: Himadri Bhattacharjee <107522312+lavafroth@users.noreply.github.com> Date: Sat, 10 Jan 2026 12:38:48 +0530 Subject: [PATCH] docs: add getting started section --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index f91c91a..0ebecd1 100644 --- a/README.md +++ b/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