diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5676fbf --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +<!-- +SPDX-FileCopyrightText: 2025 Tomasz Kramkowski <tomasz@kramkow.ski> +SPDX-License-Identifier: CC-BY-SA-4.0 +--> + +# timer + +A command line egg timer. + +## Building + +Use GNU make. + +You may need to link against `librt` on your system. To do this, pass +`LDLIBS=-lrt` to GNU make. + +To build statically, pass `LDFLAGS=-static` to GNU make. + +If you pass variables to GNU make via the command line, there's no easy way to +detect this and force a rebuild. In these cases, run the `./clean` script before +rebuilding. + +## Installation + +Place timer in a location of your choice. One way to do this may be with the +following command: + +``` +install -Dm755 timer ~/.local/bin/timer +``` |