1 files changed, 9 insertions(+), 0 deletions(-)
M README.md
M README.md => README.md +9 -0
@@ 2,3 2,12 @@ Transliterate English text from the Latin to Shavian alphabet using
[The Kingsley Read Lexicon](https://www.shavian.info/dictionary/).
(𐑑𐑮𐑨𐑯𐑟𐑤𐑦𐑑𐑼𐑱𐑑 𐑦𐑙𐑜𐑤𐑦𐑖 𐑑𐑧𐑒𐑕𐑑 𐑓𐑮𐑪𐑥 𐑞 𐑤𐑨𐑑𐑦𐑯 𐑑 𐑖𐑱𐑝𐑾𐑯 𐑨𐑤𐑓𐑩𐑚𐑧𐑑)
+
+Requires the [Nim](https://nim-lang.org) compiler and the Nimble utility to
+build:
+```
+nimble install https://git.sr.ht/~ehmry/shaviliterator
+
+export PATH=$PATH:$HOME/.nimble/bin
+fortune | shaviliterator
+```