/make/arduino-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/arduino-mk

« back to all changes in this revision

Viewing changes to arduino.mk

  • Committer: Tim Marston
  • Date: 2013-02-25 22:42:47 UTC
  • Revision ID: tim@ed.am-20130225224247-mlvghfkv6qiy0ns2
updated reference documentation

Show diffs side-by-side

added added

removed removed

arduino.mk
28
28
#
29
29
#
30
30
# This is a general purpose makefile for use with Arduino hardware and
31
 
# software.  It works with the arduino-1.0 software release.  To download the
32
 
# latest version of this makefile, visit the following website, where you can
33
 
# also find more information and documentation on it's use.  The following text
34
 
# can only really be considered a reference to it's use.
 
31
# software.  It works with the arduino-1.0 and later software releases.  It
 
32
# should work GNU/Linux and OS X.  To download the latest version of this
 
33
# makefile visit the following website where you can also find documentation on
 
34
# it's use.  (The following text can only really be considered a reference.)
35
35
#
36
36
#   http://ed.am/dev/make/arduino-mk
37
37
#
38
38
# This makefile can be used as a drop-in replacement for the Arduino IDE's
39
 
# build system.  To use it, save arduino.mk somewhere (I keep mine at
40
 
# ~/src/arduino.mk) and create a symlink to it in your project directory named
41
 
# "Makefile".  For example:
 
39
# build system.  To use it, just copy arduino.mk in to your project directory.
 
40
# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create
 
41
# a symlink to it in your project directory, named "Makefile".  For example:
42
42
#
43
43
#   $ ln -s ~/src/arduino.mk Makefile
44
44
#
45
 
# The Arduino software (version 1.0 or later) is required.  If you are using
46
 
# Debian (or a derivative), type `apt-get install arduino`.  Otherwise, you
47
 
# will have to download the Arduino software manually from http://arduino.cc/.
48
 
# It is suggested that you install it at ~/opt/arduino if you are unsure.
 
45
# The Arduino software (version 1.0 or later) is required.  On GNU/Linux you
 
46
# can probably install the software from your package manager.  If you are
 
47
# using Debian (or a derivative), try `apt-get install arduino`.  Otherwise,
 
48
# you can download the Arduino software manually from http://arduino.cc/.  It
 
49
# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)
 
50
# if you are unsure.
49
51
#
50
52
# If you downloaded the Arduino software manually and unpacked it somewhere
51
 
# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path
52
 
# where you unpacked it.  (If unset, ARDUINODIR defaults to ~/opt/arduino and
53
 
# then /usr/share/arduino, in that order.)  You might be best to set this in
 
53
# other than ~/opt/arduino (or /Applications), you will need to set up the
 
54
# ARDUINODIR environment variable to be the path where you unpacked it.  (If
 
55
# unset, ARDUINODIR defaults to some sensible places).  You could set this in
54
56
# your ~/.profile by adding something like this:
55
57
#
56
58
#   export ARDUINODIR=~/somewhere/arduino-1.0
57
59
#
58
 
# You will also need to set BOARD to the type of Arduino you're building for.
59
 
# Type `make boards` for a list of acceptable values.  You could set a default
60
 
# in your ~/.profile if you want, but it is suggested that you specify this at
61
 
# build time, especially if you work with different types of Arduino.  For
62
 
# example:
 
60
# For each project, you will also need to set BOARD to the type of Arduino
 
61
# you're building for.  Type `make boards` for a list of acceptable values.
 
62
# For example:
63
63
#
64
64
#   $ export BOARD=uno
65
65
#   $ make
70
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
71
71
# files in the project directory (or any "util" or "utility" subdirectories)
72
72
# are automatically included in the build and are scanned for Arduino libraries
73
 
# that have been #included.  Note, there can only be one .ino (or .pde) file.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file in
 
74
# a project directory and if you want to be compatible with the Arduino IDE, it
 
75
# should be called the same as the directory name.
74
76
#
75
77
# Alternatively, if you want to manually specify build variables, create a
76
78
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
77
 
# (There is no need to define TARGET).  Here is an example Makefile:
 
79
# (There is no need to define TARGET).  You can also specify the BOARD here, if
 
80
# the project has a specific one.  Here is an example Makefile:
78
81
#
79
82
#   SOURCES := main.cc other.cc
80
83
#   LIBRARIES := EEPROM
 
84
#   BOARD := pro5v
81
85
#   include ~/src/arduino.mk
82
86
#
83
87
# Here is a complete list of configuration parameters:
88
92
#              ARDUINO version constant.  This defaults to 100 if undefined.
89
93
#
90
94
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
91
 
#              based on where the avrdude in use is.  If empty, no avrdude.conf
92
 
#              is passed to avrdude (to the system default is used).
 
95
#              based on where avrdude is.  If set empty, no avrdude.conf is
 
96
#              passed to avrdude (so the system default is used).
93
97
#
94
98
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
95
99
#              required to build the project, will be appended to this.
112
116
#
113
117
# LIBRARYPATH  A space-separated list of directories that is searched in order
114
118
#              when looking for Arduino libraries.  This defaults to "libs",
115
 
#              "libraries" and then the Arduino software's libraries directory.
 
119
#              "libraries" (in the project directory), then your sketchbook
 
120
#              "libraries" directory, then the Arduino libraries directory.
116
121
#
117
 
# SERIALDEV    The unix device name of the serial device that is the Arduino.
118
 
#              If unspecified, an attempt is made to determine the name of a
119
 
#              connected Arduino's serial device.
 
122
# SERIALDEV    The POSIX device name of the serial device that is the Arduino.
 
123
#              If unspecified, an attempt is made to guess the name of a
 
124
#              connected Arduino's serial device, which may work in some cases.
120
125
#
121
126
# SOURCES      A list of all source files of whatever language.  The language
122
127
#              type is determined by the file extension.  This is set
134
139
#
135
140
# target       Builds the target.
136
141
#
137
 
# upload       Uploads the last built target to an attached Arduino.
 
142
# upload       Uploads the target (building it, as necessary) to an attached
 
143
#              Arduino.
138
144
#
139
145
# clean        Deletes files created during the build.
140
146
#