aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSimon John <git@the-jedi.co.uk>2014-01-13 12:14:31 +0000
committerSudar <sudar@sudarmuthu.com>2014-01-14 14:23:25 +0530
commitd4e0a383ae6ad13615e1c82a48646886cf175d2f (patch)
treed72633a2227d923bdfc55b50a7a17d413dd35e52 /README.md
parentfa6b9215c83e4629b24beb0ca3704b1a3ee3eec1 (diff)
Simplify package vs git checkout detection
Fix #147 Fix #151 Fix #153 The following are the detailed changes - Remove ARDMK_PATH, ARDMK_FILE and arduino-mk subdirectory - Looks for ard-reset-arduino in $PATH or ARDMK_DIR/bin - Fix git-archive command in RPM SPEC file - Remove some whitespace - Remove arduino-mk dir from debian package's arduino-mk.install - Update docs to reflect the above changes - Bump Up version to 1.2.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index d6a7f18..5dd9e39 100644
--- a/README.md
+++ b/README.md
@@ -14,17 +14,17 @@ On the Mac you might want to set:
ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java
ARDMK_DIR = /usr/local
+ AVR_TOOLS_DIR = /usr
-On Linux, you might prefer:
+On Linux, you shouldn't need to set anything other than your board type and port:
- ARDUINO_DIR = /usr/share/arduino
- ARDMK_DIR = /usr/share/arduino
- ARDMK_PATH = /usr/bin
- AVR_TOOLS_DIR = /usr
+ BOARD_TAG = mega2560
+ MONITOR_PORT = /dev/ttyACM0
+- `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`
- `ARDUINO_DIR` - Path to Arduino installation
- `ARDMK_DIR` - Path where the `*.mk` are present. If you installed the package, then it is usually `/usr/share/arduino`
-- `ARDMK_PATH` - Path where the `ard-reset-arduino` script is present. If you installed the package, then it is usually `/usr/bin`
- `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.
The Makefile also delegates resetting the board to a short Perl program.
@@ -80,7 +80,7 @@ It is possible to use [`colorgcc`](https://github.com/colorgcc/colorgcc) with th
## Versioning
-The current version of the makefile is `1.1.0`. You can find the full history in the [HISTORY.md](HISTORY.md) file
+The current version of the makefile is `1.2.0`. You can find the full history in the [HISTORY.md](HISTORY.md) file
This project adheres to Semantic [Versioning 2.0](http://semver.org/).
@@ -92,7 +92,7 @@ published by the Free Software Foundation; either version 2.1 of the License, or
## Contribution
-All contributions (even documentation) are welcome :) Open a pull request and I would be happy to merge them.
+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/).
@@ -108,7 +108,7 @@ If you find an issue or have an idea for a feature then log them in the [issue t
## 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.
+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