diff options
Diffstat (limited to 'ardmk-init.1')
| -rw-r--r-- | ardmk-init.1 | 60 |
1 files changed, 60 insertions, 0 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. |
