Start with README

Signed-off-by: Jan Pokorný <jpokorny@redhat.com>

1 files changed, 33 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9d56cee
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+acronyms-misc
+-------------
+
+This is a collection of random acronyms I want to have tracked somewhere,
+mainly for my own reference.
+
+Luckily, there is already infrastructure to use these -- wtf utility
+(the name fits if you ask me, but nobody is meant to be offended)
+from bsd-games package.  Setting things up to start using this "dictionary"
+is as easy as:
+
+
+$ # install the respective package (for Fedora)
+$ su -c 'yum install -y bsd-games'
+
+$ # have the new acronyms base recognized, e.g.:
+$ cat  >>~/.profile <<EOF
+export ACRONYMDB=\$(ls /usr/share/misc/acronyms* $(pwd)/acronyms* 2>/dev/null)
+EOF
+$ source ~/.profile
+
+$ # or alternatively and less nicely:
+$ su -c 'ln -s $(pwd)/acronyms* /usr/share/misc/'
+
+$ # let's test it:
+$ wtf fd
+FD: Full disclosure, also ML [http://ur1.ca/hhxhq]
+
+
+If something is missing, please let me know.  Patches especially welcome.
+
+-- 
+Jan <jpokorny @at@ redhat .dot. com>