From: Kashish Sharma Date: Sun, 21 Apr 2019 07:47:28 +0000 (+0530) Subject: Add headings X-Git-Url: http://gitweb.fperrin.net/?p=Dictionary.git;a=commitdiff_plain;h=7717deec013e2df5a8e38d26f3a7a252eac6f11b;hp=6a362da7f5a73d76545daecc35fde78e16c67a55 Add headings --- diff --git a/README.md b/README.md index b840adb..1c3e87b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ +# QuickDic +An offline dictionary for Android. + +## Cloning 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, clone the DictionaryPC repository as well. It needs to be at the same level as this one, not inside it. + +## Compiling 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. +## Generating dictionaries And approximation of the steps for generating dictionaries: 1. Go into the DictionaryPC repository 2. Run `data/downloadInputs.sh` to get the data