Add a very basic readme.

diff --git a/readme.txt b/readme.txt
new file mode 100644 (file)
index 0000000..4d18cc9
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,23 @@
+Make sure you also checked out the Util repository,
+and if you want to generate dictionaries also the DictionaryPC
+repository.
+They need to be at the same level as this one, not inside it.
+
+To compile the APK, just open this repository in Android Studio.
+You can also use gradle directly.
+
+And approximation of the steps for generating dictionaries:
+- go into the DictionaryPC repository
+- run data/downloadInputs.sh to get the data
+- run ./compile.sh (probably needs quite a few things to be installed or paths in it configured)
+- run ./WiktionarySplitter.sh
+- run ./generate_dictionaries.sh.
+  You might want to edit the settings at the start of the file
+  so it does not generate all dictionaries, and edit its input files
+  like EN-trans-dictlist.txt to add new dictionaries.
+  For a more manual approach, the commands it runs are something like
+ ./run.sh --lang1=ES --lang2=PT --lang1Stoplist=data/inputs/stoplists/es.txt \
+ --dictOut=data/outputs/ES-PT.quickdic \
+ --dictInfo="(EN)Wiktionary-based ES-PT dictionary. --input1=data/inputs/wikiSplit/en/EN.data" \
+ --input1Name=enwikitionary --input1Format=EnTranslationToTranslation \
+ --input1LangPattern1=es --input1LangPattern2=pt