Commit 15ed2a40 authored by Manuel Segimon's avatar Manuel Segimon
Browse files

Updated readme and install

parent 274231a2

INSTALL.txt

+5 −5
Original line number Diff line number Diff line
@@ -30,12 +30,12 @@ CLI Execution Instructions 
  - Move into the project directory.

  - Run `chmod +x *.sh` if you have not done so already.

  - Run the modules separately using the following bash scripts:

    - `./crawlerCLI.sh $arguments`

    - `./crawlerCLI.sh --LF [metadataFile] $arguments`, builds or adds to the metadataFile.

      - `--file crawler_test_file.txt`, the file contains a list of links and the crawler will add content from these links to the trie.

      - `--build [en, gr, it, or gr]`, this will build the trie based on the text corpus for each language.

      - `--social [subreddit name]`, this will add content from a reddit post to the trie.

    - `./checkerCLI.sh --file checker_test_file.txt`

    - `./correctorCLI.sh --file checker_test_file.txt`

      - `--build [English, German, Italian, or Portuguese]`, this will build the trie based on the text corpus for each language.

      - `--social [subreddit name]`, this will add content from a subreddit to the trie.

    - `./checkerCLI.sh --LF [metadataFile] --file checker_test_file.txt`, build the metadataFile using the crawler module.

    - `./correctorCLI.sh --LF [metadataFile] --file checker_test_file.txt`, build the metadataFile using the crawler module.



Visual GUI Execution Instructions

  - Open a terminal.

README.md

+4 −0
Original line number Diff line number Diff line
@@ -240,6 +240,10 @@ Implement no correction needed message in GUI for both corrector and checker 


Implemented find closest word for words not in the TrieNode, when running the corrector



Added the metadata input functionality to all the modules



Implemented change language feature in GUI, which allows the user to switch between languages



### Tejas Singh

Worked on base functionality of crawler: implemented Jsoup, basic data structures (such as the URL queue), and CLI (for use with files).