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 be583fa
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
# Sand
A systemd service and CLI program for setting countdown timers

# Installation
## Arch linux
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
A PKGBUILD is provided on the releases page.

1. Download the PKGBUILD into an empty directory
2. `makepkg`
3. `sudo pacman -U <built package>`

## Other distros
### Other distros

1. Make sure you have the dependencies:
- systemd
Expand All @@ -30,22 +43,12 @@ 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
## Building from source
You'll need a lean toolchain, which can be installed using [elan](https://github.com/leanprover/elan).

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 be583fa

Please sign in to comment.