From: Reimar Döffinger <Reimar.Doeffinger@gmx.de>
Date: Wed, 1 Nov 2017 21:50:28 +0000 (+0100)
Subject: Some updates to readme file, to reflect e.g. use of submodule.
X-Git-Url: http://gitweb.fperrin.net/?p=Dictionary.git;a=commitdiff_plain;h=594e2d2f2d326d6dd8507592b905956e2e93bf61

Some updates to readme file, to reflect e.g. use of submodule.
---

diff --git a/readme.txt b/readme.txt
index 4d18cc9..3fb06f8 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,10 +1,13 @@
-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.
+Make sure you use the --recursive option to clone, or otherwise
+make sure the Util submodule is correctly checked out.
+If you want to generate dictionaries also manually clone the DictionaryPC
+repository, it needs 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.
+Note that compilation is only tested on Linux.
+It is possible to disable the smallicu/makesmallicu step if it causes
+issues, though help to debug any such issue would be welcome.
 
 And approximation of the steps for generating dictionaries:
 - go into the DictionaryPC repository