From a165a3bf26525fed69a1255b3fdf5e51f9003aa0 Mon Sep 17 00:00:00 2001 From: John Whittington Date: Thu, 28 Sep 2017 13:26:29 +0100 Subject: [PATCH] ardmk-init usage added to README and HISTORY update --- HISTORY.md | 4 +++- README.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 6fa2606..df178dd 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -11,8 +11,10 @@ I tried to give credit whenever possible. If I have missed anyone, kindly add it - Tweak: Move non-standard-related items from CxxFLAGS_STD to CxxFLAGS (issue #523) (https://github.com/sej7278) - Tweak: Update Windows usage documentation and allow non-relative paths (issue #519) (https://github.com/tuna-f1sh) - Tweak: Support Cygwin Unix Python and Windows installation on Windows to pass correct port binding. (https://github.com/tuna-f1sh) -- New: Added -fdiagnostics-color to *STD flags (https://github.com/sej7278) +- New: Added -fdiagnostics-color to \*STD flags (https://github.com/sej7278) - New: Add generation of tags file using ctags, which automatically includes project libs and Arduino core. (https://github.com/tuna-f1sh) +- New: Add template Makefile and project boilerplate initialise script, `ardmk-init`. (https://github.com/tuna-f1sh) +- New: Support atmelice_isp JTAG tool as ISP programmer. (https://github.com/tuna-f1sh) ### 1.6.0 (2017-07-11) - Fix: Allowed for SparkFun's weird usb pid/vid submenu shenanigans (issue #499). (https://github.com/sej7278) diff --git a/README.md b/README.md index 972b03d..953d067 100644 --- a/README.md +++ b/README.md @@ -428,6 +428,20 @@ all of the examples. The bootstrap script is primarily intended for use by a continuous integration server, specifically Travis CI. It is not intended for normal users. +## Makefile Generator and Project Initialisation + +`ardmk-init` within the bin/ folder is a utility Python script to create a +Arduino-mk Makefile for a project and also has option to create a traditional *tree* +organization (src, lib, bin). It can be used as with commanline arguments or +prompted - see examples below (append `$ARDMK_DIR/bin/` to command if not on path): + +* Run prompted within current working directory: `ardmk-init` +* Create Arduino Uno Makefile (useful within a library example): `ardmk-init -qb uno` +* Create boilerplate Arduino Uno project in current working directory of same + name: `ardmk-init -b uno --quiet --project` +* Create Arduino-mk nano Makefile in current working directory with template .ino: `ardmk-init -b nano -u atmega328 -qtn my-project` +* See `ardmk-init --help` for more. + ### Bare-Arduino–Project 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.