Add installation guide to Readme file
This commit is contained in:
parent
700f82b3f1
commit
18688003a3
1 changed files with 8 additions and 6 deletions
14
README.md
14
README.md
|
@ -2,12 +2,7 @@
|
||||||
|
|
||||||
This is a very simple Makefile which knows how to build Arduino sketches. It defines the 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.
|
This is a very simple Makefile which knows how to build Arduino sketches. It defines the 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.
|
||||||
|
|
||||||
If you're using Debian or Ubuntu, you can find this in the `arduino-mk` package.
|
If you're using FreeBSD, Debian or Ubuntu, you can find this in the `arduino-mk` package.
|
||||||
|
|
||||||
## 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)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -50,6 +45,8 @@ On other systems:
|
||||||
cpanm Device::SerialPort
|
cpanm Device::SerialPort
|
||||||
cpanm YAML
|
cpanm YAML
|
||||||
|
|
||||||
|
You can also find more [detailed instructions in this guide](http://hardwarefun.com/tutorials/compiling-arduino-sketches-using-makefile) or also checkout the sample makefiles inside the examples/ folder
|
||||||
|
|
||||||
## User Libraries
|
## User Libraries
|
||||||
|
|
||||||
In order to use Arduino libraries installed in the user's sketchbook folder (the
|
In order to use Arduino libraries installed in the user's sketchbook folder (the
|
||||||
|
@ -78,6 +75,11 @@ If you are looking for ideas to work on, then check out the following TODO items
|
||||||
|
|
||||||
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/)
|
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
|
## 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).
|
- 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).
|
- Alan's Makefile was used in a [Pragmatic Programmer's article](http://pragprog.com/magazines/2011-04/advanced-arduino-hacking).
|
||||||
|
|
Loading…
Reference in a new issue