Skip to content

Commit 55c149f

Browse files
committed
Add ardmk-init manpage and correct typos
1 parent b8f5eaa commit 55c149f

File tree

2 files changed

+62
-2
lines changed

2 files changed

+62
-2
lines changed

ardmk-init.1

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
.TH ARDMK-INIT "1" "Oct 2017" "ardmk-init" "Arduino Makefile Generator"
2+
3+
.SH NAME
4+
ardmk-init - Generate Arduino Makefile environments
5+
6+
.SH SYNOPSIS
7+
.B ardmk-init
8+
[OPTION]...
9+
10+
.SH OPTIONS
11+
.B \-v, \-\-verbose
12+
Print file contents during creation.
13+
14+
.B \-d, \-\-directory
15+
Directory to run generator.
16+
17+
.B \-b, \-\-board
18+
Board tag.
19+
20+
.B \-u, \-\-micro
21+
Microcontroller on board.
22+
23+
.B \-f, \-\-freq
24+
Clock frequency.
25+
26+
.B \-p, \-\-port
27+
Monitor port.
28+
29+
.B \-n, \-\-name
30+
Project name.
31+
32+
.B \-q, \-\-quiet
33+
Run quiet without user prompts.
34+
35+
.B \-p, \-\-project
36+
Create boilerplate project with src, lib and bin folder structure.
37+
38+
.B \-t, \-\-template
39+
Create bare minimum Arduino source file.
40+
41+
.SH DESCRIPTION
42+
Creates a Makefile and project tree structure from templates.
43+
44+
.SH EXAMPLE
45+
ardmk-init -qb uno # create Arduino uno Makefile quietly
46+
.PP
47+
ardmk-init # run with user prompts
48+
.PP
49+
ardmk-init --board uno --project --template --name my-project --quiet # create Arduino uno project and template with name "my-project"
50+
51+
.SH BUGS
52+
Problems may reported on the github project page at:
53+
.PP
54+
https://github.com/sudar/Arduino-Makefile
55+
56+
.SH AUTHOR
57+
John Whittington, [email protected]
58+
59+
.SH LICENSE
60+
This is under MIT license.

bin/ardmk-init

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"""
33
Arduino-mk Makefile and project initialiser
44
5-
This script can be used in it's basic form create a project specific Makefile
5+
This script can be used in its basic form create a project specific Makefile
66
for use with Arduino-mk. Addionally, it can be used to create a template
77
Arduino source file and a traditional boilerplate project file structure.
88
@@ -46,7 +46,7 @@ PARSER.add_argument('-v', '--verbose', action='store_true',
4646
PARSER.add_argument('-d', '--directory', default=os.getcwd(), help='directory to run generator')
4747
PARSER.add_argument('-b', '--board', default='uno', help='board tag')
4848
PARSER.add_argument('-u', '--micro', default='AUTO', help='microcontroller on board')
49-
PARSER.add_argument('-f', '--freq', default='AUTO', help='mlock frequency')
49+
PARSER.add_argument('-f', '--freq', default='AUTO', help='clock frequency')
5050
PARSER.add_argument('-p', '--port', default='AUTO', help='monitor port')
5151
PARSER.add_argument('-n', '--name', default=os.path.basename(os.getcwd()), help='project name')
5252
PARSER.add_argument('-q', '--quiet', action='store_true', help='run quiet without user prompts')

0 commit comments

Comments
 (0)