From dbe8ff875649358bef16572a3699117fe67b7ebc Mon Sep 17 00:00:00 2001 From: G Roques Date: Mon, 23 Apr 2018 14:07:43 -0500 Subject: [PATCH] Add command line argument help in usage section --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec212bb..566e97c 100644 --- a/README.md +++ b/README.md @@ -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