From fb1f643a8176696f4f532c9c3c425c2e3930ee7e Mon Sep 17 00:00:00 2001 From: ladislas Date: Tue, 15 Jul 2014 22:50:31 +0200 Subject: [PATCH] Add Bare-Arduino-Project reference to "Usage" in README.md --- HISTORY.md | 1 + README.md | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 59ac5f1..0b367c9 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -5,6 +5,7 @@ The following is the rough list of changes that went into different versions. I tried to give credit whenever possible. If I have missed anyone, kindly add it to the list. ### In development +- Add: Add "Advanced Usage" and reference to the Bare-Arduino-Project in the README. (Issue #220) (https://github.com/ladislas) - Tweak: Allow remove of any OBJDIR with `$(REMOVE) $(OBJDIR)`. (https://github.com/ladislas) - Fix: Change "tinyladi" username to "ladislas" in HISTORY.md. (https://github.com/ladislas) diff --git a/README.md b/README.md index cd0626f..5b549b6 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,8 @@ On other systems: ## Usage +### Standard Usage + You can also find more [detailed instructions in this guide](http://hardwarefun.com/tutorials/compiling-arduino-sketches-using-makefile). You can also checkout the sample makefiles inside the `examples/` directory, e.g. [Makefile-example](examples/MakefileExample/Makefile-example.mk). @@ -118,8 +120,6 @@ Instead of: ARDUINO_DIR=../../../../../Program\ Files\ \(x86\)/Arduino - - - `BOARD_TAG` - Type of board, for a list see boards.txt or `make show_boards` - `MONITOR_PORT` - The port where your Arduino is plugged in, usually `/dev/ttyACM0` or `/dev/ttyUSB0` in Linux or Mac OS X and `com3`, `com4`, etc. in Windows. - `ARDUINO_DIR` - Path to Arduino installation. In Cygwin in Windows this path must be @@ -129,6 +129,16 @@ Instead of: The list of all variables that can be overridden is available at [arduino-mk-vars.md](arduino-mk-vars.md) file. +### Advanced Usage + + If you are planning on using the [Arduino-Makefile](https://github.com/sudar/Arduino-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. + + Similar to HTML frameworks, [Bare-Arduino–Project](https://github.com/WeAreLeka/Bare-Arduino-Project) aims at providing a basic `tree` organization, `Makefile` configurations for both OS X and Linux and a handful of instruction on how to get started with a robust Arduino project architecture. + + Of course, as it is just a framework, everything is customizable to suit your needs. + + Further information are available in the [README.md](https://github.com/WeAreLeka/Bare-Arduino-Project/blob/master/README.md) as well as in the [use/installation procedure](https://github.com/WeAreLeka/Bare-Arduino-Project/blob/master/INSTALL.md). + ## Including Libraries You can specify space separated list of libraries that are needed for your sketch to the variable `ARDUINO_LIBS`.