From cc5268cceb79e9f3e4d72b39df28ae243a63abfe Mon Sep 17 00:00:00 2001 From: Sudar Date: Wed, 16 Jul 2014 12:08:32 +0530 Subject: Add "Interfacing with other projects" section in README --- README.md | 63 ++++++++++++++++++++++++++++++++------------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cd0626f..ff9cf60 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,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 @@ -151,11 +150,41 @@ To upload compiled files, `avrdude` is used. This Makefile tries to find `avrdud AVRDDUDE = /usr/bin/avrdude AVRDUDE_CONF = /etc/avrdude.conf -## Colorgcc +## Versioning + +The current version of the makefile is `1.3.4`. 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/) + +## Interfacing with other projects/frameworks/IDE's + +### 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. -## Emacs/Flymake support +### Emacs/Flymake support On-the-fly syntax checking in Emacs using the [Flymake](http://www.emacswiki.org/emacs/FlyMake) minor mode is now possible. @@ -183,34 +212,6 @@ Then, the following line must be added to the project Makefile : $(CXX_NAME) -c -include Arduino.h -x c++ $(CXXFLAGS) $(CPPFLAGS) -fsyntax-only $(CHK_SOURCES) ``` -## Versioning - -The current version of the makefile is `1.3.4`. 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. -- cgit v1.2.3