Commit 36fcd050 authored by Michael D Harkess's avatar Michael D Harkess
Browse files

Updated README and INSTALL

parent 77215077
Loading
Loading
Loading
Loading
+6 −1
Original line number Diff line number Diff line
@@ -37,3 +37,8 @@ To build the project for CheckerCorrector we are using a make file. Running `mak

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

The following are the controls for the app once launched:
- `+` Button: Add a new sentence/Phrase to store in a visual list.
- Short Press on a Phrase: Brings up a dialog showing the output of the checker on the tapped phrase/sentence.
- Long Press on a Phrase: Brings up a dialog to delete the phrase from the stored list.
 No newline at end of file
+14 −5
Original line number Diff line number Diff line
@@ -11,19 +11,28 @@ Michael Harkess
Reza Sajjadi

### Implementation Description
A high-level description of the implementation, with particular emphasis on the design decisions related to data structures and algorithms

### Implemented Features
- Provide real-time status and statistics ( e.g., what URL is being processed, rate of processing, size of storage, etc.) feedback for the crawler. [10%]
    - IMPLEMENTATION DESCRIPTION
    - Description of how it was implemented with an emphasis on data structures and algorithms used
- Provide a list of reasonable corrections to a suspicious text, ranked in order of how different they are from the original text. [15%]
    - IMPLEMENTATION DESCRIPTION
    - Description of how it was implemented with an emphasis on data structures and algorithms used
- Graphical User Interface that highlights suspicious and non-suspicious textual elements in a given text. [15%]
    - IMPLEMENTATION DESCRIPTION
    - Description of how it was implemented with an emphasis on data structures and algorithms used
- Provide a graphical human feedback system for deciding among possible phrase corrections, with feedback into the suspicion levels reported by the system. [15%]
    - IMPLEMENTATION DESCRIPTION
    - Description of how it was implemented with an emphasis on data structures and algorithms used
- Develop and Android client for your checker. [15%]
    - For the most part, the Android client of the checker is interfacing with the Checker CLI tool to produce its output in a pop-up window on the app. To do this, the Checker tool was modified so that it did not write the checked result to a JSON file (and instead kept it as a JSON string) as well as not require CLI arguments for the script to function. In addition, helper class functions were used to display the output to the user in the app.

#### Changed Features from Initial Defense Report

##### Added
- Feature 1

##### Removed
- Feature 1

### References
https://docs.oracle.com/javase/tutorial/networking/urls/index.html

@@ -62,4 +71,4 @@ The correction at this point is limited to the state machine complexity, but it
### Known Issues/Bugs
#### Android App
- If a dialog box pops up and the device/screen is rotated, then the app will unexpectedly crash
- The confidence score of every word in a given sentence is 0
- The confidence score of every word in a given sentence/phrase is 0