@@ -49,6 +49,25 @@ Usage: java ScratchCrawler [--file <file_path>] or [--seed <seed_url>] or [--hel
## Checker/Corrector
To build the project for CheckerCorrector we are using a make file. Running `make dev_corrector` and `make dev_checker` will compile and build the `checker.jar` and `corrector.jar` with the user interface requested, and and bash script ready to be run them as `./checker --file [PATH]` and `./corrector --file [PATH]`.
```
Usage:
Corrector Options:
--file <filename>: this option should be used if you want to pass your input as file.
--sentence <sentence>: this option should be used if you want to pass your input as a small sentence.
--correctorGUI: this option can be used if you want a GUI for the corrector to select between possible suggestions.
--translateToDutch: this option should be used if you want to translate from English to Dutch. Specify the the filename in txt format or sentence option for this method.
--translateToEnglish: this option should be used if you want to translate from Dutch to English. Specify the the filename in txt format or sentence option for this method.
--dutch: this option should be used if you want to use dutch language alongside other options. The default is English.
Checker Options:
--file <filename>: this option should be used if you want to pass your input as file.
-sentence <sentence>: this option should be used if you want to pass your input as a small sentence.
--checkerGUI: this option can be used if you want a GUI for the checker to see the highlighted sentences. This option is interactive mode.
--updateToken: this option should be used alongside a file as input to update new tokens for the database from the crawled data. This option may take hours based on the size of crawled file. You must use --file <filename.txt> which has the crawled data for this option as well.
--updateTokenFromDic: this option should be used alongside a file as input to update new tokens for the database from the crawled data from a dictionary website. This option may take hours based on the size of crawled file. You must use --file <filename.txt> which has the crawled data for this option as well.
--updateHashTable: this option should be used alongside a file as input to update n-grams weights for the database. This option may take a few minutes. You must use --file <filename.txt> which has the crawled data for this option as well.
--validateUpdates: this option can be used to check the correctness of the database for tokens. This will pops up a window. You must use --file <dbname.db> for this option as well.
--dutch: this option should be used if you want to use dutch language alongside other options. The default is English.
```
## Android App
The Android App is designed to work on any android device that supports Android 10 and above. For simple installation, an apk file of the app is provided in the repo. Make sure to enable `Install from Unknown Sources` before installing the apk on your device as it may be blocked during the installation process.
