Skip to content

Commit

Permalink
Update README with instructions for command line usage
Browse files Browse the repository at this point in the history
  • Loading branch information
emmaflint27 authored Sep 29, 2016
1 parent 97f066d commit e576de4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This module takes a text as input, and returns it in a normalised form, *ie.* ex
2. [Usage](#usage)
2. [Customise to your variety](#variety)
2. [Input your own abbreviation dictionary](#abbrevs)
2. [Execute normalise from the command line](#command)
3. [Example](#example)
4. [Authors](#authors)
5. [License](#license)
Expand Down Expand Up @@ -125,6 +126,16 @@ Out:
'four hundred and fifty nine thousand pounds',
'or near offer']
```

### iii. <a name="command"><a/>Execute normalise from the command line

From the command line, you can normalise text from a given .txt file. Use the command `normalise /path/to/your-file.txt`. This will print the normalised output, as well as save it to a separate file "your-file_normalised.txt" in the same directory as the original text.

To specify the variety as American English, use `--AmE` (default is British English). For a verbose output, use `--V`:

```
normalise /path/to/your_file.txt --AmE --V
```

## 3. <a name="example"><a/>Example

Expand Down

0 comments on commit e576de4

Please sign in to comment.