diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..93e3f58 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# uncron + +Convert cron schedules into a human-readable form: + + > uncron "0 6 1 * *" + At 06:00, on the 1st of every month + > uncron "0 * 2 1-4 *" + At the top of every hour, on the 2nd from January to April + > uncron "10,30,50 * 1 1-6/3 *" + At minutes 10, 30 and 50 of every hour, on the 1st of every 3 months from January to June + +## Building & Running + +The recommended solution is to use `nix`: + +- Use `nix profile install http://git.k.mulga.net/julien/uncron/snapshot/uncron-main.tar.gz` to install uncron, +- Use `nix run http://git.k.mulga.net/julien/uncron/snapshot/uncron-main.tar.gz` to build and run the binary directly. + +If you have `cabal` installed, use `cabal build` or `cabal install`. |