]> gitweb.fperrin.net Git - Dictionary.git/commitdiff
Some updates to readme file, to reflect e.g. use of submodule.
authorReimar Döffinger <Reimar.Doeffinger@gmx.de>
Wed, 1 Nov 2017 21:50:28 +0000 (22:50 +0100)
committerReimar Döffinger <Reimar.Doeffinger@gmx.de>
Wed, 1 Nov 2017 21:50:28 +0000 (22:50 +0100)
readme.txt

index 4d18cc91f58677f85296498c3ff595457c861736..3fb06f897f75c74861e85dd20e855a7c4e6055a9 100644 (file)
@@ -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