README.md

   1 # QuickDic
   2 An offline dictionary for Android.
   3
   4 ## Cloning
   5 Make sure you use the `--recursive` option to clone, or otherwise
   6 make sure the `Util` submodule is correctly checked out.
   7
   8 If you want to generate dictionaries, clone the DictionaryPC
   9 repository as well. It needs to be at the same level as this one, not
  10 inside it.
  11
  12 ## Compiling
  13 To compile the APK, just open this repository in Android Studio.
  14 You can also use Gradle directly.
  15 Note that compilation is only tested on Linux.
  16 It is possible to disable the smallicu/makesmallicu step if it causes
  17 issues, though help to debug any such issue would be welcome.
  18
  19 ## Generating dictionaries
  20 And approximation of the steps for generating dictionaries:
  21 1. Go into the DictionaryPC repository
  22 2. Run `data/downloadInputs.sh` to get the data
  23 3. Run `./compile.sh` (probably needs quite a few things to be installed or paths in it configured)
  24 4. Run `./WiktionarySplitter.sh`
  25 5. Run `./generate_dictionaries.sh`
  26    You might want to edit the settings at the start of the file
  27    so it does not generate all dictionaries, and edit its input files
  28    like EN-trans-dictlist.txt to add new dictionaries.
  29    For a more manual approach, the commands it runs are something like
  30   `./run.sh --lang1=ES --lang2=PT --lang1Stoplist=data/inputs/stoplists/es.txt \
  31   --dictOut=data/outputs/ES-PT.quickdic \
  32   --dictInfo="(EN)Wiktionary-based ES-PT dictionary." --input1=data/inputs/wikiSplit/en/EN.data \
  33   --input1Name=enwikitionary --input1Format=EnTranslationToTranslation \
  34   --input1LangPattern1=es --input1LangPattern2=pt`