aboutsummaryrefslogtreecommitdiff
path: root/ardmk-init.1
blob: 87f03822b2c40daeb5c25bfd7d0f2bb49ad116ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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.