aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSudar <sudar@sudarmuthu.com>2013-07-26 19:00:32 +0530
committerSudar <sudar@sudarmuthu.com>2013-07-28 11:42:21 +0530
commit8fee3165f4c28ad8ab389fe526a768af04f8489f (patch)
tree2f431e61c1d400e83b24e038a756ed3b05543f26 /README.md
parentb78d8433572bafe9e025cb9592908c25c3d72229 (diff)
Update instructions about ARDMK_DIR and ARDMK_PATH
Both `ARDMK_DIR` and `ARDMK_PATH` needs to be set differently based on whether the makefile is installed through a package or git checkout. Refer to #111 to find out why it is needed.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index cf5f522..6f8235a 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,15 @@ On the Mac you might want to set:
On Linux, you might prefer:
ARDUINO_DIR = /usr/share/arduino
- ARDMK_DIR = /usr
+ ARDMK_DIR = /usr/share/arduino
+ ARDMK_PATH = /usr/bin
AVR_TOOLS_DIR = /usr
+- `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.
You'll need to install `Device::SerialPort` to use it though.