diff --git a/readme.md b/readme.md index bcfe3c8..cecfd14 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,7 @@ 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 +## Progress - [x] Print a fortune from a fortunes file - [x] Specify a cutoff for what is considered a short fortune (the `-n` flag) @@ -14,3 +14,28 @@ It's primarily an educational project in which i aim to completely reimplement t - [x] Ignore case for the pattern (the `-i` flag) - [x] Allow multiple fortune cookie files - [ ] Implement the `-f` flag + +## Installing + +Prerequisites: +* rust +* clang +* pkg-config +* openssl + +Build: +```sh +cargo install https://github.com/runebaas/fortune-mod.rs.git +``` + +## Fortune files + +Place your fortune files in one of the following locations: + +* *nix + * /usr/share/fortune + * /usr/share/games/fortunes + * ./fortunes +* windows + * ./fortunes + * ./cookies