Skip to content

Commit

Permalink
Add command line argument help in usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
gbroques committed Apr 26, 2018
1 parent 0c84f19 commit dbe8ff8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Expand Up @@ -41,7 +41,17 @@ This will install this project's dependencies on your machine.
## How to Run

```
$ python main.py
$ python main.py -h
usage: main.py [-h] filename
Train a perceptron with data stored in a text file.
positional arguments:
filename Data should be in a specific format. See data.txt for an
example.
optional arguments:
-h, --help show this help message and exit
```

## Usage
Expand Down

0 comments on commit dbe8ff8

Please sign in to comment.