Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rohansikder committed Apr 10, 2022
1 parent 89a5246 commit e94f433
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@


N-Gram Frequency Builder

N-Gram Frequency Builder is a Java N-Gram Frequency Builder to get the N-Gram of characters found in a piece of text which is stored in a .txt file.

Installation:
Please run Java -Xmx1G –cp ./ngrammer.jar ie.gmit.sw.Runner in Command Prompt whilst in the folder where the .JAR file is located.

Usage:
Option 1: Choose File Dir of your .txt File.
E.g., C:\DSA_Project\DSA_Project\bin\books\BibleGod.txt
Expand All @@ -21,15 +24,25 @@ Option 5: Exit application.
Features:

• All Menu items are in the menu class.

• User Needs to enter valid items into all fields before N-gram is calculated.

• All characters other than the alphabet from A-Z are disregarded.

• White Space is disregarded.

• Every N-Gram is outputted to lowercase.

• All Big – O Notation is commented above Each loop.

• User does not need to enter .CSV when entering output Filename.

• Automatically sorts data into 2 rows within .CSV File.

• Terminal Progress meter is built-in for visual effect.

• Books folder will be included with various books.

• Paths and environmental variables are not hard-coded.

Output Example: (N-Gram of 1 using BibleGod.txt)
Expand Down

0 comments on commit e94f433

Please sign in to comment.