Skip to content

Commit a165a3b

Browse files
committed
ardmk-init usage added to README and HISTORY update
1 parent f3bb824 commit a165a3b

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

HISTORY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ I tried to give credit whenever possible. If I have missed anyone, kindly add it
1111
- Tweak: Move non-standard-related items from CxxFLAGS_STD to CxxFLAGS (issue #523) (https://github.com/sej7278)
1212
- Tweak: Update Windows usage documentation and allow non-relative paths (issue #519) (https://github.com/tuna-f1sh)
1313
- Tweak: Support Cygwin Unix Python and Windows installation on Windows to pass correct port binding. (https://github.com/tuna-f1sh)
14-
- New: Added -fdiagnostics-color to *STD flags (https://github.com/sej7278)
14+
- New: Added -fdiagnostics-color to \*STD flags (https://github.com/sej7278)
1515
- New: Add generation of tags file using ctags, which automatically includes project libs and Arduino core. (https://github.com/tuna-f1sh)
16+
- New: Add template Makefile and project boilerplate initialise script, `ardmk-init`. (https://github.com/tuna-f1sh)
17+
- New: Support atmelice_isp JTAG tool as ISP programmer. (https://github.com/tuna-f1sh)
1618

1719
### 1.6.0 (2017-07-11)
1820
- Fix: Allowed for SparkFun's weird usb pid/vid submenu shenanigans (issue #499). (https://github.com/sej7278)

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,20 @@ all of the examples. The bootstrap script is primarily intended for use by a
428428
continuous integration server, specifically Travis CI. It is not intended for
429429
normal users.
430430

431+
## Makefile Generator and Project Initialisation
432+
433+
`ardmk-init` within the bin/ folder is a utility Python script to create a
434+
Arduino-mk Makefile for a project and also has option to create a traditional *tree*
435+
organization (src, lib, bin). It can be used as with commanline arguments or
436+
prompted - see examples below (append `$ARDMK_DIR/bin/` to command if not on path):
437+
438+
* Run prompted within current working directory: `ardmk-init`
439+
* Create Arduino Uno Makefile (useful within a library example): `ardmk-init -qb uno`
440+
* Create boilerplate Arduino Uno project in current working directory of same
441+
name: `ardmk-init -b uno --quiet --project`
442+
* Create Arduino-mk nano Makefile in current working directory with template .ino: `ardmk-init -b nano -u atmega328 -qtn my-project`
443+
* See `ardmk-init --help` for more.
444+
431445
### Bare-Arduino–Project
432446

433447
If you are planning on using this makefile in a larger/professional project, you might want to take a look at the [Bare-Arduino–Project](https://github.com/WeAreLeka/Bare-Arduino-Project) framework.

0 commit comments

Comments
 (0)