Commit 14ef8d2a authored by Alexander Ross Melnick's avatar Alexander Ross Melnick
Browse files

Update INSTALL.md

parent 996c185f

INSTALL.md

+3 −0
Original line number Diff line number Diff line
@@ -31,6 +31,7 @@ This is provided in the repo, and there is no need to download the library exter 


## Crawler

To run the webcrawler, run `./crawler` in the \Crawler\ directory. The usage is as follows. Any number of arguments are allowed. 

```

Usage: java ScratchCrawler [--file <file_path>] or [--seed <seed_url>] or [--help]

    --file <file_path>: Read URLs from a file and start crawling

    --seed <seed_url>: Start crawling from a seed URL
@@ -43,6 +44,8 @@ Usage: java ScratchCrawler [--file <file_path>] or [--seed <seed_url>] or [--hel 
    --turkish: Include crawling from Turkish website

    --xl: Increase the storage size per page to 1 MB

    --help: Display this help message

```





## 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]`.