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