Add ardmk-init manpage and correct typos

2 files changed, 62 insertions, 2 deletions

diff --git a/ardmk-init.1 b/ardmk-init.1
new file mode 100644
index 0000000..87f0382
--- /dev/null
+++ b/ardmk-init.1
@@ -0,0 +1,60 @@
+.TH ARDMK-INIT "1" "Oct 2017" "ardmk-init" "Arduino Makefile Generator"
+
+.SH NAME
+ardmk-init - Generate Arduino Makefile environments
+
+.SH SYNOPSIS
+.B ardmk-init
+[OPTION]...
+
+.SH OPTIONS
+.B \-v, \-\-verbose
+Print file contents during creation.
+
+.B \-d, \-\-directory
+Directory to run generator.
+
+.B \-b, \-\-board
+Board tag.
+
+.B \-u, \-\-micro
+Microcontroller on board.
+
+.B \-f, \-\-freq
+Clock frequency.
+
+.B \-p, \-\-port
+Monitor port.
+
+.B \-n, \-\-name
+Project name.
+
+.B \-q, \-\-quiet
+Run quiet without user prompts.
+
+.B \-p, \-\-project
+Create boilerplate project with src, lib and bin folder structure.
+
+.B \-t, \-\-template
+Create bare minimum Arduino source file.
+
+.SH DESCRIPTION
+Creates a Makefile and project tree structure from templates.
+
+.SH EXAMPLE
+ardmk-init -qb uno # create Arduino uno Makefile quietly
+.PP
+ardmk-init # run with user prompts
+.PP
+ardmk-init --board uno --project --template --name my-project --quiet # create Arduino uno project and template with name "my-project"
+
+.SH BUGS
+Problems may reported on the github project page at:
+.PP
+https://github.com/sudar/Arduino-Makefile
+
+.SH AUTHOR
+John Whittington, git@jbrengineering.co.uk
+
+.SH LICENSE
+This is under MIT license.
diff --git a/bin/ardmk-init b/bin/ardmk-init
index ec1f3b8..bf932d5 100755
--- a/bin/ardmk-init
+++ b/bin/ardmk-init
@@ -2,7 +2,7 @@
 """
 Arduino-mk Makefile and project initialiser
 
-This script can be used in it's basic form create a project specific Makefile
+This script can be used in its basic form create a project specific Makefile
 for use with Arduino-mk. Addionally, it can be used to create a template
 Arduino source file and a traditional boilerplate project file structure.
 
@@ -46,7 +46,7 @@ PARSER.add_argument('-v', '--verbose', action='store_true',
 PARSER.add_argument('-d', '--directory', default=os.getcwd(), help='directory to run generator')
 PARSER.add_argument('-b', '--board', default='uno', help='board tag')
 PARSER.add_argument('-u', '--micro', default='AUTO', help='microcontroller on board')
-PARSER.add_argument('-f', '--freq', default='AUTO', help='mlock frequency')
+PARSER.add_argument('-f', '--freq', default='AUTO', help='clock frequency')
 PARSER.add_argument('-p', '--port', default='AUTO', help='monitor port')
 PARSER.add_argument('-n', '--name', default=os.path.basename(os.getcwd()), help='project name')
 PARSER.add_argument('-q', '--quiet', action='store_true', help='run quiet without user prompts')