From 55c149fb0352a56b57fce98c706a0a23f743a66b Mon Sep 17 00:00:00 2001
From: John Whittington <john.whittington@cruxproductdesign.com>
Date: Fri, 6 Oct 2017 10:32:17 +0100
Subject: Add ardmk-init manpage and correct typos

---
 ardmk-init.1 | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 ardmk-init.1

(limited to 'ardmk-init.1')

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.
-- 
cgit v1.2.3


From d874c59103fc9619df906c0f967bcfa539325592 Mon Sep 17 00:00:00 2001
From: John Whittington <john.whittington@cruxproductdesign.com>
Date: Tue, 7 Nov 2017 16:54:34 +0000
Subject: ardmk-init runs without prompt by default, cli arg added to avoid
 clint dependency

---
 ardmk-init.1 | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'ardmk-init.1')

diff --git a/ardmk-init.1 b/ardmk-init.1
index 87f0382..bb83fd2 100644
--- a/ardmk-init.1
+++ b/ardmk-init.1
@@ -1,4 +1,4 @@
-.TH ARDMK-INIT "1" "Oct 2017" "ardmk-init" "Arduino Makefile Generator"
+.TH ARDMK-INIT "1" "Nov 2017" "ardmk-init" "Arduino Makefile Generator"
 
 .SH NAME
 ardmk-init - Generate Arduino Makefile environments
@@ -29,8 +29,8 @@ Monitor port.
 .B \-n, \-\-name
 Project name.
 
-.B \-q, \-\-quiet
-Run quiet without user prompts.
+.B \-\-cli
+Run with user prompts rather than arguments.
 
 .B \-p, \-\-project
 Create boilerplate project with src, lib and bin folder structure.
@@ -42,11 +42,11 @@ Create bare minimum Arduino source file.
 Creates a Makefile and project tree structure from templates.
 
 .SH EXAMPLE
-ardmk-init -qb uno # create Arduino uno Makefile quietly
+ardmk-init -b uno # create Arduino uno Makefile
 .PP
-ardmk-init # run with user prompts
+ardmk-init --cli # 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"
+ardmk-init --board uno --project --template --name my-project # create Arduino uno project and template with name "my-project"
 
 .SH BUGS
 Problems may reported on the github project page at:
-- 
cgit v1.2.3