Add README, make things a bit more general

1 files changed, 34 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..eaeab74
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+Oxford English Dictionary, 2nd Edition v3 dict edition
+========================================================
+
+This is a collection of scripts to convert the Oxford English
+Dictionary, 2nd Edition (software version v3) into the jargon
+and DICT formats.
+
+Dependencies
+------------
+
+- To create DICT files the 'dictfmt' and 'dictzip' tools need to
+  be installed.
+
+- The files 1-10.htm from the OED CDs need to be copied into this
+  directory. Some are under the 'Data/' directory on the CDs.
+
+Install
+-------
+
+- To create a .jargon file, run 'make oed.jargon'
+
+- To create a .dict file, run 'make oed.dict', or for a compressed
+  version 'make oed.dict.dz'
+
+- To install the dictionary for dictd, run 'make install'
+
+Note
+----
+
+The dictionary included in v3 is the same as v4, but with v4 the
+OED started encrypting the dictionary files. They probably wouldn't
+be difficult to decrypt, but I haven't the time or inclination to
+do so. If anyone wants to, let me know how you get on and I'll
+very happily incorporate support for it.