Skip to content

Commit

Permalink
release v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sullyj3 committed Aug 3, 2024
1 parent c1cae86 commit 8193bd7
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ jobs:
pytest test_daemon.py
- name: Create release archive
env:
GIT_DESCRIBE: ${{ steps.ghd.outputs.describe }}
run: ./create_release_archive.sh
if: startsWith(github.ref, 'refs/tags/v')
- name: Release
Expand Down
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,31 @@ timers from your app launcher/command runner of choice.

```bash
$ sand 5m
Timer created for 00:05:00:000.
$ sand 1h 30s
Timer created for 01:00:30:000.
$ sand ls
#1 | 00:04:51:856 remaining
#2 | 01:00:27:686 remaining
#2 | 01:00:27:313 remaining
#1 | 00:04:51:340 remaining
```
A sound will play and a desktop notification will be triggered when a timer
elapses.

I use it for remembering to get things out of the oven.

## 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

1. Make sure you have the dependencies:
- systemd
- libnotify
- optionally, pulseaudio or wireplumber (for timer notification sounds)

2. Download and extract the latest tarball from the releases page
3. `cd release`
4. The install script, `install.sh` is currently only tested on Arch.
3. The install script, `install_release.sh` is currently only tested on Arch.
It should work on any distro that follows the FHS. However, I would
recommend reading it and confirming that it will work correctly on your
distro.
5. `sudo ./install.sh`
4. inside the release directory, run `sudo ./install_release.sh`

## Setup
After installing, you'll need to enable and start the service.
Expand Down
10 changes: 9 additions & 1 deletion create_release_archive.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ if [ ! -f .lake/build/bin/sand ]; then
fi

# git describe doesn't work by default in CI, so we use an action for it.
version=${GIT_DESCRIBE:-$(git describe)}
if [ -z "$GIT_DESCRIBE" ]; then
echo "Not in CI, running git describe"
version="$(git describe)"
else
echo "In CI, getting version from GIT_DESCRIBE"
version=$GIT_DESCRIBE
fi


dir="sand-$version"

set -x
Expand Down

0 comments on commit 8193bd7

Please sign in to comment.