Skip to content

Commit

Permalink
tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sullyj3 committed Jul 26, 2024
1 parent 1fc1595 commit 510b842
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Sand
A systemd service and CLI program for setting countdown timers
#Sand

Countdown timers that don't take up a terminal.

`sand` runs as a daemon in the background, allowing you to set long timers
without having to worry about keeping the terminal open.

```
$ sand 30
$ sand ls
#1 | 00:00:25:026 remaining
```
A sound will play and a desktop notification will be triggered when the timer
elapses.

# Installation
## Arch linux
Expand Down Expand Up @@ -30,16 +44,6 @@ After installing, you'll need to enable and start the service.
1. `systemctl --user daemon-reload`
2. `systemctl --user enable --now sand.socket`

### Usage
```
$ sand 30
$ sand ls
#1 | 00:00:04:026 remaining
```
A notification will be triggered when the timer elapses.

### Building from source
You'll need a lean toolchain, which can be installed using [elan](https://github.com/leanprover/elan).

Expand All @@ -48,4 +52,4 @@ Once that's done, run
lake build
```

The executable will be in `./.lake/build/bin/sand`.
The executable will be in `./.lake/build/bin/sand`.

0 comments on commit 510b842

Please sign in to comment.