From 4c35d88b86b9315f6a8942e81e55b0c7b7170b81 Mon Sep 17 00:00:00 2001 From: Nick White Date: Wed, 7 Aug 2024 21:39:56 +0100 Subject: Update README --- README | 58 ++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 34 insertions(+), 24 deletions(-) (limited to 'README') diff --git a/README b/README index af81ead..0ed8fa8 100644 --- a/README +++ b/README @@ -1,38 +1,48 @@ -Oxford English Dictionary, 2nd Edition v3 dict edition -======================================================== +Oxford English Dictionary, 2nd Edition v3 converters +================================================================= This is a collection of scripts to convert the Oxford English -Dictionary, 2nd Edition (software version v3) into the jargon -and DICT formats. +Dictionary, 2nd Edition (software version v3) into the various +open formats: jargon, DICT, slob and stardict. + +These formats can be loaded into a variety of free software. I +recommend: +- GoldenDict-ng (Linux / MacOS / Windows) [DICT or slob format] +- Aard 2 (Android) [slob format] +- KOReader (eReaders) [stardict format] + +Being open formats the dictionary data can easily be analysed +by other programs or converted into other formats. Dependencies ------------ -- To create DICT files the 'dictfmt' and 'dictzip' tools need to +- 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 slob and stardict files the `pyglossary` and `slob` + tools need to be installed. -- To create a .jargon file, run 'make oed.jargon' +- The files 1-10.htm from the OED CDs need to be copied into this + directory. Some are in the `Data` directory on the CDs. -- To create a .dict file, run 'make oed.dict', or for a compressed - version 'make oed.dict.dz' +Build +----- -- To install the dictionary for dictd, run 'make install' +To build all versions, run `make`. -Notes ------ +Alternatively, you can build just the formats you want with +`make `, where `` is one of: +- `oed.jargon`: jargon file. +- `oed.dict`: DICT file +- `oed.dict.dz`: compressed DICT file +- `oed.slob`: slob file +- `stardict/oed.ifo`: stardict file -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. +Naming +------ -If your version of make supports it, and you have multiple CPUs, you -can use 'make -j' instead of 'make' to significantly speed up the -build process. +This project started out just converting to jargon and DICT +formats, hence the name oed2dict, but over time other formats +have gained prominence and utility, so it was expanded to +support them too. -- cgit v1.2.3