arduino-mk 1.0.1

data/vendor/Arduino-Makefile/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing To Arduino Makefile
+
+Community made patches, localizations, bug reports, documentation and contributions are always welcome and are crucial to the success of this project.
+
+When contributing please ensure you follow the guidelines below so that we can keep on top of things.
+
+## Getting Started
+
+Submit a ticket for your issue, assuming one does not already exist.
+
+- Raise it on our [Issue Tracker](https://github.com/sudar/Arduino-Makefile/issues)
+- Clearly describe the issue including steps to reproduce the bug.
+- Make sure you fill in the earliest version that you know has the issue as well as the following
+    - Your operating system (Mac, Linux/Unix, Windows)
+    - Your Arduino IDE version
+    - Snippet of your makefile
+
+## Making Changes
+
+- Fork the repository on GitHub
+- Make the changes to your forked repository
+- Update the [changelog file](HISTORY.md) and add a note about your change. If possible prefix it with either Fix, Tweak or New
+- If you are adding or changing the behavior of any variable, then update the corresponding documentation in the [arduino-mk-vars.md](arduino-mk-vars.md) file as well
+- When committing, reference your issue (if present) and include a note about the fix
+    - If possible (and if makes sense) do atomic commits
+    - Try to follow [this guideline](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) while choosing the git commit message
+- Push the changes to your fork and submit a pull request to the 'master' branch of the this repository
+
+At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.
+
+# Additional Resources
+
+- [General GitHub Documentation](http://help.github.com/)
+- [GitHub Pull Request documentation](http://help.github.com/send-pull-requests/)
+- [Guide about contributing code in GitHub](http://sudarmuthu.com/blog/contributing-to-project-hosted-in-github)

data/vendor/Arduino-Makefile/Common.mk

@@ -0,0 +1,46 @@
+# Useful functions
+# Returns the first argument (typically a directory), if the file or directory
+# named by concatenating the first and optionally second argument
+# (directory and optional filename) exists
+dir_if_exists = $(if $(wildcard $(1)$(2)),$(1))
+
+# Run a shell script if it exists. Stops make on error.
+runscript_if_exists =                                                          \
+    $(if $(wildcard $(1)),                                                     \
+         $(if $(findstring 0,                                                  \
+                  $(lastword $(shell $(abspath $(wildcard $(1))); echo $$?))), \
+              $(info Info: $(1) success),                                      \
+              $(error ERROR: $(1) failed)))
+
+# For message printing: pad the right side of the first argument with spaces to
+# the number of bytes indicated by the second argument.
+space_pad_to = $(shell echo $(1) "                                                      " | head -c$(2))
+
+# Call with some text, and a prefix tag if desired (like [AUTODETECTED]),
+show_config_info = $(call arduino_output,- $(call space_pad_to,$(2),20) $(1))
+
+# Call with the name of the variable, a prefix tag if desired (like [AUTODETECTED]),
+# and an explanation if desired (like (found in $$PATH)
+show_config_variable = $(call show_config_info,$(1) = $($(1)) $(3),$(2))
+
+# Just a nice simple visual separator
+show_separator = $(call arduino_output,-------------------------)
+
+$(call show_separator)
+$(call arduino_output,Arduino.mk Configuration:)
+
+########################################################################
+#
+# Detect OS
+ifeq ($(OS),Windows_NT)
+    CURRENT_OS = WINDOWS
+else
+    UNAME_S := $(shell uname -s)
+    ifeq ($(UNAME_S),Linux)
+        CURRENT_OS = LINUX
+    endif
+    ifeq ($(UNAME_S),Darwin)
+        CURRENT_OS = MAC
+    endif
+endif
+$(call show_config_variable,CURRENT_OS,[AUTODETECTED])

data/vendor/Arduino-Makefile/HISTORY.md

@@ -0,0 +1,225 @@
+A Makefile for Arduino Sketches
+===============================
+
+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.
+
+### 1.3.4 (In development)
+- Tweak: Allow spaces in "Serial.begin (....)". (Issue #190) (https://github.com/pdav)
+- Add: Add support for compiling assembler code. (Issue #195) (https://github.com/hrobeers)
+- Add: Try to guess port from wildcards if not specified. (Issue #197) (https://github.com/tuzz)
+
+### 1.3.3 (2014-04-12)
+- Fix: Make a new manpage for ard-reset-arduino. Fixes issue #188 (https://github.com/sej7278)
+
+### 1.3.2 (2014-04-11)
+- Fix: Add arduino-mk-vars.md file to RPM SPECfile. (https://github.com/sej7278)
+- Fix: Add avr-libc/malloc.c and realloc.c to included core files. Fixes issue #163 (https://github.com/sej7278)
+- Fix: Add "gpio" to the list of isp that don't have a port. (Issue #165, #166) (https://github.com/sej7278)
+- Fix: Add "-D__PROG_TYPES_COMPAT__" to the avr-g++ compiler flags to match IDE. (https://github.com/sej7278)
+- New: Create `Makefile-example-mk`, a *real life* `Makefile` example, to be used as a reference. (https://github.com/tinyladi)
+- Tweak: Add `OBJDIR` to `arduino-mk-vars.md` (https://github.com/tinyladi)
+- Tweak: *Beautify* `arduino-mk-vars.md` with code blocks. (https://github.com/tinyladi)
+- Fix: AVR tools paths for chipKIT in Linux. (https://github.com/peplin)
+- Fix: Consider usb or usb:... to be a valid ISP_PORT (https://github.com/geoffholden)
+- Add: Add phony target to run pre-build hook script (https://github.com/jrid)
+- Fix: Add BOOTLOADER_PARENT to `arduino-mk-vars.md` and fixed BOOTLOADER_PATH example. (https://github.com/sej7278)
+- Tweak: Replace perl reset script with Python script. (https://github.com/sej7278)
+- Tweak: Made choice of Python2/3 interpreter up to the OS. (https://github.com/peplin)
+- Tweak: Simplified packaging dependencies. (https://github.com/sej7278)
+- Tweak: Tweak AVRDUDE conf detection in windows. (https://github.com/EAGMnor)
+
+### 1.3.1 (2014-02-04)
+- Fix: BUNDLED_AVR_TOOLS_DIR is now set properly when using only arduino-core and not the whole arduino package. (https://github.com/sej7278)
+- New: Document all variables that can be overridden. (https://github.com/sej7278)
+- New: Add a new `help_vars` target to display information about variables that can be overridden.
+
+### 1.3.0 (2014-01-29)
+- Fix: Use more reliable serial device naming in Windows. Fix issue #139 and #155 (https://github.com/peplin)
+- Fix: Document that ARDUINO_DIR must be a relative path in Windows. Fix issue #156 (https://github.com/peplin)
+- Tweak: Don't hard code MONITOR_PORT in examples, for more flexible testing. (Issue #157) (https://github.com/peplin)
+- Tweak: Silence the stderr output from call to `which`. (Issue #158) (https://github.com/peplin)
+- Fix: Override complete compiler tool paths for chipKIT. (Issue #159) (https://github.com/peplin)
+- New: The makefile is compatible with Windows
+- New: Update `README.md` file about usage and Windows compatibility
+
+### 1.2.0 (2014-01-14)
+- Add: Add RPM SPECfile and new `package` directory to store package instructions and files (https://github.com/sej7278)
+- Fix: Remove use of arduino-mk subdirectory in git. Fix issue #151, #152 and #147 (https://github.com/sej7278)
+- Fix: Remove `arduino-mk` directory from all examples. Fix #154
+
+### 1.1.0 (2013-12-26)
+- Don't append port details to avrdude for usbasp. See #123
+- Ignore commented lines while parsing boards.txt file. See #124
+- In ISP mode, read baudrate and programmer from boards.txt. See #125
+- Add `burn_bootloader` target. See #85
+- Show correct path to `arduino.mk` file in help message. Fix #120
+- Change echo for printf. Fix #129 (https://github.com/thomassigurdsen)
+- Add support for ChipKiT 2013. Fix #136 (https://github.com/peplin)
+- Auto detect and include libraries specified in `USER_LIB_PATH`. Fix #135 (https://github.com/tinyladi)
+- Use `MAKEFILE_LIST` to get the name of the make file. Fix #130 (https://github.com/cantora)
+- New: Add option to set fuses without burning a bootloader. Fix #141 (https://github.com/sej7278)
+- Tweak: Don't append port details to avrdude for usbtiny. Fix #140 and #138 (https://github.com/PPvG)
+- Fix: Handle relative paths of bootloader file while burning bootloaders. Fix #126 and #142 (https://github.com/sej7278)
+- New: Add `CONTRIBUTING.md` explaining how to contribute to the project.
+- New: Force -Os optimization for SoftwareSerial. Add `OPTIMIZATION_FLAGS` and `DEBUG_FLAGS`. (https://github.com/mahoy)
+- Fix: Use `ARDUINO_HEADER` variable instead of hardcoded file names. Fix #131
+
+### 1.0.1 (2013-09-25)
+- Unconditionally add -D in avrdude options. See #114
+
+### 1.0.0 (2013-09-22)
+- Add $OBJDIR to the list of configuration that gets printed. Fix issue #77
+- Add support for specifying optimization level. Fix issue #81
+- Add support for reseting "Micro" Arduino. Fix issue #80 (https://github.com/sej7278)
+- Remove "utility" from example makefiles. Fix issue #84
+- Auto detect alternate core path from sketchbook folder. Fix issue #86
+- Remove redundant checks for ARDUINO_DIR
+- Improve avrdude and avrdude.conf path auto detection. Fix issue #48
+- Move binary sketch size verification logic inside makefile. Fix issue #54
+- Remove dependency on wait-connection-leonardo shell script. Fix issue #95
+- Add support for the Digilent chipKIT platform. (https://github.com/peplin)
+- Implement ard-parse-boards with shell scripting instead of Perl (https://github.com/peplin)
+- Compile with debugging symbols only when DEBUG=1 (https://github.com/peplin)
+- Replace Leonardo detection with Caterina detection (https://github.com/sej7278)
+- Autodetect baudrate only if either a .ino/.pde is present
+- Allow building with Arduino core, without a .ino/.pde file
+- Ability to support different Arduino cores (https://github.com/sej7278)
+
+### 0.12.0 (2013-06-20)
+- Fix "generated_assembly" target, which got broken earlier. Fix issue #76 (https://github.com/matthijskooijman)
+- Deprecate "generated_assembly" target in favour of "generate_assembly". Fix issue #79
+
+### 0.11.0 (2013-06-15)
+- Replace hardcoded executables with variable
+- Fix whitespace issues
+- Add a warning when HEX_MAXIMUM_SIZE is not specified
+- Add the ability to configure avrdude options. Fix issue #53
+- Handle cases where certain fuse bits are not present. Fix issue #61
+- Add support for compiling plain AVR C files. Fix issue #63
+- Add an example to show how to compile AVR C files. Fix issue #73
+
+### 0.10.6 (2013-06-14)
+- Fix whitespace and add /dev/null redirection (https://github.com/sej7278)
+- Change the way AUTO_ARDUINO_VERSION is computed (https://github.com/sej7278)
+- Make serial monitor baudrate detection work in Mac as well(https://github.com/sej7278)
+- Fix directory creation for library source files (https://github.com/matthijskooijman)
+- Rewrite ard-leonardo-reset script in perl (https://github.com/sej7278)
+
+### 0.10.5 (2013-06-11)
+- Add USB_VID and USB_PID to CPPFLAGS only if the board is Leonardo.
+- Allow adding extra common dependencies (COMMON_DEPS) (https://github.com/gaftech)
+- Added ifndef ARDUINO_VAR_PATH for compiling for the attiny (https://github.com/danielesteban)
+- Strip extra whitespace from the `BOARD_TAG` variable
+- Enhanced support for programming using Arduino as ISP
+- Added example to show how to program using Arduino as ISP
+- Add support for Leonardo boards. Took code from (https://github.com/guicho271828)
+
+### 0.10.4 (2013-05-31) @matthijskooijman
+- Improved BAUD_RATE detection logic
+- Added logic to check if there is only .ino or .pde file
+- Compile .ino/.pde files directly
+- Output configuration only once
+- Try to read Version.txt file only if it is present
+- Refactored dependency code
+
+###	0.10.3 16.xii 2012 gaftech
+- Enabling creation of EEPROM file (.eep)
+- EEPROM upload: eeprom and raw_eeprom targets
+- Auto EEPROM upload with isp mode: ISP_EEPROM option.
+- Allow custom OBJDIR
+
+### 0.10.2 15.xii.2012 Sudar
+- Added sketch size verification. (https://github.com/fornellas)
+- Show original line number for error messages (https://github.com/WizenedEE)
+- Removed -w from CPPFLAGS to show warnings (https://github.com/gaftech)
+- Changed shebang to use /usr/bin/env (https://github.com/anm)
+- set USB_VID and USB_PID only for leonardo boards(https://github.com/alohr)
+- Updated Readme (https://github.com/fr0sty1/)
+
+###  0.10.1 15.xii.2012 Sudar
+- Merged all changes from Upstream and the following changes from https://github.com/rpavlik
+- Allow passing extra flags
+- Make listing files more useful
+- Add knowledge of device-specific assembler
+- Use variables instead of hardcoded commands
+- Make disasm more helpful
+- Change .sym output
+- Provide symbol_sizes and generated_assembly targets.
+- Be able to silence configuration output
+- Make everybody depend on the makefile, in case cflags are changed, etc.
+- Make the makefile error if the arduino port is not present.
+
+###   0.10 17.ix.12   M J Oldfield
+- Added installation notes for Fedora (ex Rickard Lindberg).
+- Changed size target so that it looks at the ELF object,
+    not the hexfile (ex Jared Szechy and Scott Howard).
+- Fixed ARDUNIO typo in README.md (ex Kalin Kozhuharov).
+- Tweaked OBJDIR handling (ex Matthias Urlichs and Scott Howard).
+- Changed the name of the Debian/Ubuntu package (ex
+    Scott Howard).
+- Only set AVRDUDE_CONF if it's not set (ex Tom Hall).
+- Added support for USB_PID/VID used by the Leonardo (ex Dan
+    Villiom Podlaski Christiansen and Marc Plano-Lesay).
+
+###   0.9.3.2 10.ix.2012 Sudar
+- Fixed a typo in README. Issue reported at upstream (https://github.com/mjoldfield/Arduino-Makefile/issues/21)
+
+###   0.9.3.1 18.viii.2012 jeffkowalski
+
+- Autodetect ARDUINO_LIBS from includes in LOCAL_SRCS
+- Autodetect ARDUINO_SKETCHBOOK from file set by Arduino IDE
+- Autodetect ARDMK_DIR based on location of this file
+- Added support for utility directory within SYS and USER libraries
+
+### 0.9.3 13.vi.2012
+
+- Auto detect ARDUINO_DIR, Arduino version (https://github.com/rpavlik/)
+- Categorize libs into user and system (https://github.com/rpavlik/)
+- Dump size at the end of the build (https://github.com/rpavlik/)
+- Lots and lots of improvements (https://github.com/rpavlik/)
+- Changed bytes option for the head shell command, so that it works in Mac as well
+- Auto detect Serial Baud rate from sketch if possible
+
+### 0.9.2 06.vi.2012
+
+- Allow user to choose source files (LOCAL_*_SRCS flags) (https://github.com/Gaftech)
+- Modified "make size" behavior: using --mcu option and targeting .elf file instead of .hex file.(https://github.com/Gaftech)
+
+### 0.9.1 06.vi.2012
+
+- Corrected the ubuntu package names
+- Prevent the *file-not-found* error if the depends.mk file is not needed
+- Delete the build-cli folder as well while doing make clean
+- Added support for compiling .pde files in Arduino 1.0 environment
+- Replaced = with += in CPPFLAGS assignment so that we can set CPPFLAGS per sketch if needed
+- Changed AVRDUDE_CONF so it can be defined in per-project makefile (https://github.com/WizenedEE)
+- Cleaner way to delete the build-cli directory when make clean is invoked
+- The package name in Debian and Ubuntu is arduino-mk (https://github.com/maqifrnswa)
+
+### 2012-02-12, version 0.8
+- Patches for version 1.0 of the Arduino IDE. Older versions might still work, but I’ve not tested it.
+- A change to the build process: rather than link all the system objects directly into the executable, bundle them in a library first. This should make the final executable smaller.
+- If TARGET isn’t explicitly set, default to the current directory name. Thanks to Daniele Vergini for this patch.
+- Add support for .c files in system libraries: Dirk-Willem van Gulik and Evan Goldenberg both reported this and provided patches in the same spirit.
+- Added a size target as suggested by Alex Satrapa.
+
+### Unreleased, version 0.7
+- Added -lm to the linker options, and -F to stty.
+
+### 2011-06-23, version 0.6
+- Added ard-parse-boards. Mark Sproul suggested doing something like this ages ago, but I’ve only recently looked at it in detail.
+- Fabien Le Lez reported that one needs to link with -lc to avoid [linker errors](http://forum.arduino.cc/index.php/topic,40215.0.html).
+
+### 2011-06-23, version 0.5
+- Imported changes from Debian/Ubuntu, which incorporate a patch from Stefan Tomanek so that libraries would be compiled too.
+
+Note: Many other people sent me similar patches, but I didn't get around to using them. In the end, I took the patch from Debian and Ubuntu: there seems merit in not forking the code and using a tested version. So, thanks and apologies to Nick Andrew, Leandro Coletto Biazon, Thibaud Chupin, Craig Hollabaugh, Johannes H. Jensen, Fabien Le Lez, Craig Leres, and Mark Sproul.
+
+### 2010-05-24, version 0.4
+Tweaked rules for the reset target on Philip Hands’ advice.
+
+### 2010-05-21, version 0.3
+- Tidied up the licensing, making it clear that it’s released under LGPL 2.1.
+- [Philip Hands](http://hands.com/~phil/) sent me some code to reset the Arduino by dropping DTR for 100ms, and I added it.
+- Tweaked the Makefile to handle version 0018 of the Arduino software which now includes main.cpp. Accordingly we don’t need to—and indeed must not—add main.cxx to the .pde sketch file. The paths seem to have changed a bit too.

data/vendor/Arduino-Makefile/README.md

@@ -0,0 +1,189 @@
+# A Makefile for Arduino Sketches
+
+This is a very simple Makefile which knows how to build Arduino sketches. It defines entire workflows for compiling code, flashing it to Arduino and even communicating through Serial monitor. You don't need to change anything in the Arduino sketches.
+
+## Features
+
+- Very robust
+- Highly customizable
+- Supports all official AVR-based Arduino boards
+- Supports chipKIT
+- Works on all three major OS (Mac, Linux, Windows)
+- Auto detects serial baud rate and libraries used
+- Support for `*.ino` and `*.pde` sketches as well as raw `*.c` and `*.cpp`
+- Support for Arduino Software versions 1.0.x as well as 0.x.
+Support for Arduino 1.5.x is still work in progress
+- Automatic dependency tracking. Referred libraries are automatically included
+in the build process. Changes in `*.h` files lead to recompilation of sources which include them
+
+## Installation
+
+### Through package
+
+If you're using FreeBSD, Debian or Ubuntu, you can find this in the `arduino-mk`
+package and can be installed using `apt-get` or `aptitude`.
+
+### From source
+
+- Download the latest release
+- Or clone it from Github using the command `git clone git@github.com:sudar/Arduino-Makefile.git`
+- Check the [usage section](https://github.com/sudar/Arduino-Makefile#usage) in this readme about setting usage options
+
+## Requirements
+
+You need to have the Arduino IDE. You can either install it through the
+installer or download the distribution zip file and extract it.
+
+The Makefile also delegates resetting the board to a short Python program.
+You'll need to install `pySerial` to use it though.
+
+On Debian or Ubuntu:
+
+       apt-get install python-serial
+
+On Fedora:
+
+       yum install pyserial
+
+On openSUSE:
+
+      zypper install python-serial
+
+On Mac using MacPorts:
+
+      sudo port install py27-serial
+
+On Windows:
+
+You need to install Cygwin and its packages for Make, Perl and the next Serial library.
+
+       pySerial can be downloaded from PyPi
+
+On other systems:
+
+       pip install pyserial
+
+        or
+
+       easy_install -U pyserial
+
+## 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/` folder or take a look at a *real* [Makefile-example](examples/MakefileExample/Makefile-example.mk).
+
+Download a copy of this repo some where in your system or install it through a package.
+
+On the Mac you might want to set:
+
+    ARDUINO_DIR   = /Applications/Arduino.app/Contents/Resources/Java
+    ARDMK_DIR     = /usr/local
+    AVR_TOOLS_DIR = /usr
+    MONITOR_PORT  = /dev/ttyACM0
+    BOARD_TAG     = mega2560
+
+On Linux (if you have installed through package), you shouldn't need to set anything other than your board type and port:
+
+    BOARD_TAG     = mega2560
+    MONITOR_PORT  = /dev/ttyACM0
+
+On Windows (using cygwin), you might want to set:
+
+    ARDUINO_DIR   = ../../arduino
+    ARDMK_DIR     = path/to/mkfile
+    MONITOR_PORT  = com3
+    BOARD_TAG     = mega2560
+
+It is recommended in Windows that you create a symbolic link directory for avoiding problem with folder naming conventions on Windows. Specially if your your Arduino folder is in:
+
+c:\Program Files (x86)\Arduino
+
+You will get problem for the special characters on the folder name. More details about this can be found on https://github.com/sudar/Arduino-Makefile/issues/94
+
+For creating a symbolic link you have to use the command “mklink” on Windows, e.g.
+
+mklink /d c:\Arduino c:\Program Files (x86)\Arduino
+
+At the end the variables end up being.
+
+ARDUINO_DIR=../../../../../Arduino
+
+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
+  relative, not absolute (e.g. "../../arduino" and not "/c/cygwin/Arduino").
+- `ARDMK_DIR`   - Path where the `*.mk` are present. If you installed the package, then it is usually `/usr/share/arduino`
+- `AVR_TOOLS_DIR` - Path where the avr tools chain binaries are present. If you are going to use the binaries that came with Arduino installation, then you don't have to set it. Otherwise set it realtive and not absolute.
+
+The list of all variables that can be overridden is available at [arduino-mk-vars.md](arduino-mk-vars.md) file.
+
+## Including Libraries
+
+You can specify space separated list of libraries that are needed for your sketch to the variable `ARDUINO_LIBS`.
+
+`ARDUINO_LIBS = Wire SoftwareSerial`
+
+The libraries will be searched in the following places in the following order.
+
+- `/libraries` folder inside your sketchbook folder. Sketchbook folder will be auto detected from your Arduino preference file. You can also manually set it through `ARDUINO_SKETCHBOOK`.
+- `/libraries` folder inside your Arduino folder, which is read from `ARDUINO_DIR`.
+
+The libraries inside user folder will take precedence over libraries present in Arduino core folder.
+
+The makefile can autodetect the libraries that are included from your sketch and can include them automatically. But it can't detect libraries that are included from other libraries. (see [issue #93](https://github.com/sudar/Arduino-Makefile/issues/93))
+
+## avrdude
+
+To upload compiled files, `avrdude` is used. This Makefile tries to find `avrdude` and it's config (`avrdude.conf`) below `ARDUINO_DIR`. If you like to use the one installed on your system instead of the one which came with Arduino, you can try to set the variables `AVRDUDE` and `AVRDUDE_CONF`. On a typical Linux system these could be set to
+
+      AVRDDUDE     = /usr/bin/avrdude
+      AVRDUDE_CONF = /etc/avrdude.conf
+
+## Colorgcc
+
+It is possible to use [`colorgcc`](https://github.com/colorgcc/colorgcc) with this makefile. Check out [this comment](http://hardwarefun.com/tutorials/compiling-arduino-sketches-using-makefile#comment-1408) to find usage instructions.
+
+## Versioning
+
+The current version of the makefile is `1.3.3`. You can find the full history in the [HISTORY.md](HISTORY.md) file
+
+This project adheres to Semantic [Versioning 2.0](http://semver.org/).
+
+## License
+
+This makefile and the related documentation and examples are free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
+
+## Contribution
+
+All contributions (even documentation) are welcome :) Open a pull request and I would be happy to merge them.
+Also checkout the [contribution guide](CONTRIBUTING.md) for more details.
+
+If you are looking for ideas to work on, then check out the following TODO items or the [issue tracker](https://github.com/sudar/Arduino-Makefile/issues/).
+
+## Limitations / Know Issues / TODO's
+
+- Doesn't work with Arduino 1.5.x yet. Follow [issue #45](https://github.com/sudar/Arduino-Makefile/issues/45) for progress.
+- Since it doesn't do any pre processing like Arduino IDE, you have to declare all methods before you use them ([issue #59](https://github.com/sudar/Arduino-Makefile/issues/59))
+- More than one .ino or .pde file is not supported yet ([issue #49](https://github.com/sudar/Arduino-Makefile/issues/49))
+- When you compile for the first time, it builds all libs inside Arduino directory even if it is not needed. But while linking only the relevant files are linked. ([issue #29](https://github.com/sudar/Arduino-Makefile/issues/29)). Even Arduino IDE does the same thing though.
+
+If you find an issue or have an idea for a feature then log them in the [issue tracker](https://github.com/sudar/Arduino-Makefile/issues/)
+
+## Credits
+
+This makefile was originally created by [Martin Oldfield](http://mjo.tc/atelier/2009/02/arduino-cli.html) and he maintained it till v0.10.2.
+From May 2013, it is maintained by [Sudar](http://hardwarefun.com/tutorials/compiling-arduino-sketches-using-makefile)
+
+## Similar works
+- It's not a derivative of this, but Alan Burlison has written a [similar thing](http://bleaklow.com/2010/06/04/a_makefile_for_arduino_sketches.html).
+- Alan's Makefile was used in a [Pragmatic Programmer's article](http://pragprog.com/magazines/2011-04/advanced-arduino-hacking).
+- Rei Vilo wrote to tell me that he's using the Makefile ina Xcode 4 template called [embedXcode](http://embedxcode.weebly.com/). Apparently it supports many platforms and boards, including AVR-based Arduino, AVR-based Wiring, PIC32-based chipKIT, MSP430-based LaunchPad and ARM3-based Maple.