/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: edam
  • Date: 2012-01-25 14:22:11 UTC
  • Revision ID: edam@waxworlds.org-20120125142211-a71y2gj505076zzz
formatting, and changed default for ARDUINODIR

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
21
21
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
22
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
23
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
 
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25
 
# THE SOFTWARE.
 
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
25
# SOFTWARE.
26
26
#
27
27
#_______________________________________________________________________________
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 release and requires that
32
 
# software to be downloaded separately (see http://arduino.cc/).  To
33
 
# download the latest version of this makefile, visit the following
34
 
# website, where you can also find more information and documentation
35
 
# on it's use.  The following text can only really be considered a
36
 
# reference to it's use.
 
31
# software.  It works with the arduino-1.0 release and requires that software
 
32
# to be downloaded separately (see http://arduino.cc/).  To download the latest
 
33
# version of this makefile, visit the following website, where you can also
 
34
# find more information and documentation on it's use.  The following text can
 
35
# only really be considered a reference to it's use.
37
36
#
38
37
#   http://ed.am/dev/make/arduino-makefile
39
38
#
40
 
# To install, it is suggested that you keep arduino.mk somewhere and
41
 
# either symlink to it or include it in your make files.  I keep mine
42
 
# at ~/src/arduino.mk.  You will need to alter the value of the
43
 
# ARDUINODIR variable (below) to be the path where you have unpacked
44
 
# the arduino software from arduino.cc.
 
39
# To install, it is suggested that you keep arduino.mk somewhere and either
 
40
# symlink to it or include it in your make files.  I keep mine at
 
41
# ~/src/arduino.mk.  You will need to alter the value of the ARDUINODIR
 
42
# variable (below) to be the path where you have unpacked the arduino software
 
43
# from arduino.cc.
45
44
#
46
 
# This makefile can be used as a drop-in replacement for the Arduino
47
 
# IDE's build system.  Simply create a symlink to it under the name
48
 
# "Makefile" and run make (remembering to specify an ARDUINODIR and
49
 
# BOARD, as described below).  You would create the symlink like like
50
 
# so:
 
45
# This makefile can be used as a drop-in replacement for the Arduino IDE's
 
46
# build system.  Simply create a symlink to it under the name "Makefile" and
 
47
# run make (remembering to specify an ARDUINODIR and BOARD, as described
 
48
# below).  You would create the symlink like like so:
51
49
#
52
50
#   $ ln -s ~/src/arduino.mk Makefile
53
51
#
54
 
# The presence of a .ino or .pde file causes the arduino.mk to
55
 
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
56
 
# Any .c, .cc and .cpp files in the project directory (or a "util" or
57
 
# "utility" subdirectory) are automatically included in the build and
58
 
# are scanned for libraries that have been #included.
 
52
# The presence of a .ino or .pde file causes the arduino.mk to atuomatically
 
53
# determine va;ues for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
54
# files in the project directory (or a "util" or "utility" subdirectory) are
 
55
# automatically included in the build and are scanned for libraries that have
 
56
# been #included.
59
57
#
60
 
# Alternatively, if you want to manually specify build variables,
61
 
# create a Makefile that defines SOURCES and LIBRARARIES and then
62
 
# includes arduino.mk.  (There is no need to define TARGET).  You will
63
 
# also be expected to provide a main() function, for example in
64
 
# main.cc, which may or may not duplicate the functionality of the
65
 
# default main() that calls init() and loop().  Here is an example
66
 
# Makefile:
 
58
# Alternatively, if you want to manually specify build variables, create a
 
59
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
 
60
# (There is no need to define TARGET).  You will also be expected to provide a
 
61
# main() function, for example in main.cc, which may or may not duplicate the
 
62
# functionality of the default main() that calls init() and loop().  Here is an
 
63
# example Makefile:
67
64
#
68
65
#   SOURCES := main.cc foo.cc
69
66
#   LIBRARIES := EEPROM
70
67
#   include ~/src/arduino.mk
71
68
#
72
 
# A complete list of all the settings you can use in your Makefile
73
 
# follows shortly.  It should be noted, however, that some variables
74
 
# are better specified in the environment (or on the command line)
75
 
# than in your Makefile.  Specifically, the ARDUINODIR, BOARD and, if
76
 
# it is not automatically detected, SERIALDEV.
77
 
#
78
 
# When running make, you might want to specify the board and path to
79
 
# your installation of the arduino software, like this:
80
 
#
81
 
#   $ export ARDUINODIR=~/opt/arduino-1.0
 
69
# A complete list of all the settings you can use in your Makefile follows
 
70
# shortly.  It should be noted, however, that some variables are better
 
71
# specified in the environment (or on the command line) than in your Makefile.
 
72
# Specifically, the ARDUINODIR, BOARD and, if it is not automatically detected,
 
73
# SERIALDEV.
 
74
#
 
75
# When running make, you might want to specify the board and path to your
 
76
# installation of the arduino software, like this:
 
77
#
 
78
#   $ export ARDUINODIR=~/opt/arduino
82
79
#   $ export BOARD=pro5v
83
80
#   $ make
84
81
#
86
83
# 
87
84
# Here is a complete list of configuration parameters:
88
85
#
89
 
# ARDUINODIR   The path where you have installed/unpacked the arduino
90
 
#              software (from http://arduino.cc/)
 
86
# ARDUINODIR   The path where you have installed/unpacked the arduino software
 
87
#              (from http://arduino.cc/)
91
88
#
92
89
# BOARD        Specify a target board type.
93
90
#
94
 
# SERIALDEV    The unix device of the device where the arduino can be
95
 
#              found.  If unspecified, an attempt is made to determine
96
 
#              the name of a connected arduino's serial device.
97
 
#
98
 
# TARGET       The name of the target file.  This is set automatically
99
 
#              if a .ino or .pde is found, but it is not neccesary to
100
 
#              set it otherwise.
101
 
#
102
 
# SOURCES      A list of all source files of whatever language.  The
103
 
#              language type is determined by the file extension.
104
 
#              This is set automatically if a .ino or .pde is found.
105
 
#
106
 
# LIBRARIES    A list of arduino libraries to build and include.  This
107
 
#              is set automatically if a .ino or .pde is found.
 
91
# SERIALDEV    The unix device of the device where the arduino can be found.
 
92
#              If unspecified, an attempt is made to determine the name of a
 
93
#              connected arduino's serial device.
 
94
#
 
95
# TARGET       The name of the target file.  This is set automatically if a
 
96
#              .ino or .pde is found, but it is not neccesary to set it
 
97
#              otherwise.
 
98
#
 
99
# SOURCES      A list of all source files of whatever language.  The language
 
100
#              type is determined by the file extension.  This is set
 
101
#              automatically if a .ino or .pde is found.
 
102
#
 
103
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
104
#              automatically if a .ino or .pde is found.
108
105
#
109
106
# This general-purpose makefile also defines the following goals for
110
107
# use on the command line when you run make:
111
108
#
112
 
# all          This is the default if no goal is specified. It builds
113
 
#              the target and uploads it.
 
109
# all          This is the default if no goal is specified. It builds the
 
110
#              target and uploads it.
114
111
#
115
112
# target       Builds the target of your Makefile.
116
113
#
118
115
#
119
116
# clean        Deletes temporary files.
120
117
#
121
 
# <file>       Builds the specified file, either an object file or the
122
 
#              target, from those that that would be built for the
123
 
#              project.
124
 
#
125
 
# boards       This is not a real goal.  It just displays a list of
126
 
#              available board names, so that you can set the BOARD
127
 
#              environment variable appropriately.
128
 
#
129
 
# monitor      This is not a real goal.  It starts screen on the serial
130
 
#              device.  It is ment to be an equivelant to the arduino
131
 
#              serial monitor.
 
118
# boards       Display a list of available board names, so that you can set the
 
119
#              BOARD environment variable appropriately.
 
120
#
 
121
# monitor      Start `screen` on the serial device.  It is ment to be an
 
122
#              equivelant to the arduino serial monitor.
 
123
#
 
124
# <file>       Builds the specified file, either an object file or the target,
 
125
#              from those that that would be built for the project.
132
126
#_______________________________________________________________________________
133
127
#
134
128
 
135
129
# The full path to the arduino software, from arduino.cc
136
130
ifndef ARDUINODIR
137
 
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
 
131
ARDUINODIR := $(wildcard ~/opt/arduino)
138
132
endif
139
133
 
140
134
# check arduino software