Skip to content
This repository was archived by the owner on Apr 12, 2026. It is now read-only.

Commit ca0f1ed

Browse files
committed
make docs: Better intro to make system readme
The make system readme now gives a basic primer on how to compile tinyos applications.
1 parent 4c8ef1c commit ca0f1ed

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

support/make/README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,36 @@
11
TinyOS Make System Version 3
22
============================
33

4+
Building a TinyOS application consists of running `make` followed by a target
5+
and a series of optional extras. For example, to compile Blink, a very basic
6+
app, for the `telosb` platform you simply run:
7+
8+
$ cd ../../apps/Blink
9+
$ make telosb
10+
11+
Compiling an application requires `nesc` to be installed, as well as the correct
12+
toolchain for the hardware you are compiling for.
13+
14+
Targets tell the Make system which hardware platform you are intending to build
15+
the application for. Extras allow you to further configure how an application is
16+
built or run additional commands after compilation is complete. One example is
17+
loading the executable onto the hardware itself. This typically looks like:
18+
19+
$ make telosb install
20+
21+
To get a list of all valid targets and extras, run `make` in any application
22+
directory.
23+
24+
The remainder of this README explains in depth how the TinyOS make system works,
25+
how to configure it, how to add a new target, platform, or extra, how to setup
26+
an external TinyOS tree and how to adapt TinyOS make system version 2 files
27+
to the current make system.
28+
29+
30+
31+
Updated Make System (Summer 2014)
32+
---------------------------------
33+
434
The new version of the make system started out as a method to remove the
535
environment variable requirement from the TinyOS install. All parts of the build
636
system that relied on having those environment variables set now use reasonable
@@ -70,15 +100,6 @@ There are several main changes from version two:
70100

71101

72102

73-
Quick Start
74-
-----------
75-
76-
To use this build system find an application, and try make
77-
78-
cd ../../apps/Blink #or any app dir
79-
make telos help
80-
81-
82103

83104

84105
Directory Structure and Naming Conventions

0 commit comments

Comments
 (0)