From 34dd7f7609f97ded4dda71b0c43fd75c808cf188 Mon Sep 17 00:00:00 2001 From: runebaas Date: Mon, 28 Oct 2019 00:29:25 +0100 Subject: [PATCH] Add a readme --- readme.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..77ae8a1 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ +# Fortune-mod (in rust) + +This is a clone of the original `fortune` command found on many unix systems + +It's primarily an educational project in which i aim to completely reimplement the command. + +### Progress + +- [x] Print a fortune from a fortunes file +- [x] Specify a cutoff for what is considered a short fortune (the `-n` flag) +- [x] Specify whether a short or a long fortune should be printed (the `-l` flag) +- [x] Wait n amount of seconds before the program exits (the `-w` flag) +- [ ] Allow multiple fortune cookie files +- [ ] Allow to filter with a pattern (the `-m` flag) +- [ ] Ignore case for the pattern (the `-i` flag)