mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
repace project by application in documentation
This commit is contained in:
parent
68bc93b0c7
commit
cb9c5d00de
@ -79,9 +79,9 @@ BASELIBS += $(USEPKG:%=${BINDIR}%.a)
|
|||||||
|
|
||||||
.PHONY: all clean flash doc term
|
.PHONY: all clean flash doc term
|
||||||
|
|
||||||
## make script for your project. Build RIOT-base here!
|
## make script for your application. Build RIOT-base here!
|
||||||
all: $(BINDIR)$(PROJECT).a
|
all: $(BINDIR)$(PROJECT).a
|
||||||
@echo "Building project $(PROJECT) for $(BOARD) w/ MCU $(MCU)."
|
@echo "Building application $(PROJECT) for $(BOARD) w/ MCU $(MCU)."
|
||||||
"$(MAKE)" -C $(RIOTBOARD)/$(BOARD)
|
"$(MAKE)" -C $(RIOTBOARD)/$(BOARD)
|
||||||
"$(MAKE)" -C $(RIOTBASE)
|
"$(MAKE)" -C $(RIOTBASE)
|
||||||
@for i in $(USEPKG) ; do "$(MAKE)" -C $(RIOTBASE)/pkg/$$i ; done ;
|
@for i in $(USEPKG) ; do "$(MAKE)" -C $(RIOTBASE)/pkg/$$i ; done ;
|
||||||
@ -94,7 +94,7 @@ endif
|
|||||||
$(AD)$(OBJCOPY) $(OFLAGS) $(BINDIR)$(PROJECT).elf $(BINDIR)$(PROJECT).hex
|
$(AD)$(OBJCOPY) $(OFLAGS) $(BINDIR)$(PROJECT).elf $(BINDIR)$(PROJECT).hex
|
||||||
|
|
||||||
## your make rules
|
## your make rules
|
||||||
## Only basic example - modify it for larger projects!!
|
## Only basic example - modify it for larger applications!!
|
||||||
#$(BINDIR)/$(PROJECT).a: $(BINDIR)/$(PROJECT).o
|
#$(BINDIR)/$(PROJECT).a: $(BINDIR)/$(PROJECT).o
|
||||||
# $(AR) -rc $(BINDIR)/project.a $(BINDIR)/$(PROJECT).o
|
# $(AR) -rc $(BINDIR)/project.a $(BINDIR)/$(PROJECT).o
|
||||||
|
|
||||||
|
@ -26,10 +26,10 @@
|
|||||||
*
|
*
|
||||||
* The offline configuration file "configure.h" is automatically
|
* The offline configuration file "configure.h" is automatically
|
||||||
* included in every file by the build system and allows to configure
|
* included in every file by the build system and allows to configure
|
||||||
* all neccessary defines on cpu, board and project level.
|
* all neccessary defines on cpu, board and application level.
|
||||||
*
|
*
|
||||||
* The configuration is built of
|
* The configuration is built of
|
||||||
* \li a project specific file (project-conf.h)
|
* \li a application specific file (project-conf.h)
|
||||||
* \li a board specific file (board-conf.h) and
|
* \li a board specific file (board-conf.h) and
|
||||||
* \li a cpu specific file (cpu-conf.h).
|
* \li a cpu specific file (cpu-conf.h).
|
||||||
* All of which are chosen by the build system depending on your arguments.
|
* All of which are chosen by the build system depending on your arguments.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
VALGRIND SUPPORT
|
VALGRIND SUPPORT
|
||||||
================
|
================
|
||||||
|
|
||||||
Rebuild your project using the all-valgrind target like this:
|
Rebuild your application using the all-valgrind target like this:
|
||||||
|
|
||||||
make -B clean all-valgrind
|
make -B clean all-valgrind
|
||||||
|
|
||||||
|
10
dist/Makefile
vendored
10
dist/Makefile
vendored
@ -1,12 +1,12 @@
|
|||||||
####
|
####
|
||||||
#### Sample Makefile for building projects with the RIOT OS
|
#### Sample Makefile for building applications with the RIOT OS
|
||||||
####
|
####
|
||||||
#### The example file system layout is:
|
#### The example file system layout is:
|
||||||
#### ./project makefile
|
#### ./application makefile
|
||||||
#### ../../RIOT
|
#### ../../RIOT
|
||||||
####
|
####
|
||||||
|
|
||||||
# Set the name of your project:
|
# Set the name of your application:
|
||||||
export PROJECT = foobar
|
export PROJECT = foobar
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
@ -46,9 +46,9 @@ export QUIET ?= 1
|
|||||||
#USEMODULE += cc110x
|
#USEMODULE += cc110x
|
||||||
#USEMODULE += fat
|
#USEMODULE += fat
|
||||||
|
|
||||||
#export INCLUDES += -Iproject_include
|
#export INCLUDES += -I application_include
|
||||||
|
|
||||||
# Specify custom dependencies for your project here ...
|
# Specify custom dependencies for your application here ...
|
||||||
# export PROJDEPS = proj_data.h
|
# export PROJDEPS = proj_data.h
|
||||||
|
|
||||||
include $(RIOTBASE)/Makefile.include
|
include $(RIOTBASE)/Makefile.include
|
||||||
|
@ -20,7 +20,7 @@
|
|||||||
* code](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-getting-the-source-code)). This contains - besides the
|
* code](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-getting-the-source-code)). This contains - besides the
|
||||||
* before mentioned features - also some example applications (located in the
|
* before mentioned features - also some example applications (located in the
|
||||||
* `examples` subdirectory) and a sample Makefile you may use for your own
|
* `examples` subdirectory) and a sample Makefile you may use for your own
|
||||||
* project. This Makefile template shows you how to compile and link your project
|
* project. This Makefile template shows you how to compile and link your application
|
||||||
* against RIOT ([Compiling RIOT](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-compiling-riot)).
|
* against RIOT ([Compiling RIOT](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-compiling-riot)).
|
||||||
*
|
*
|
||||||
* If you want to use RIOT directly with your embedded platform, you need to
|
* If you want to use RIOT directly with your embedded platform, you need to
|
||||||
@ -33,7 +33,7 @@
|
|||||||
* As a special platform, you will find a CPU and board called `native` in the
|
* As a special platform, you will find a CPU and board called `native` in the
|
||||||
* repository. This target allows you to run RIOT as a process on Linux on most
|
* repository. This target allows you to run RIOT as a process on Linux on most
|
||||||
* supported hardware platforms. Just set CPU and BOARD to `native` in your
|
* supported hardware platforms. Just set CPU and BOARD to `native` in your
|
||||||
* project's Makefile, call `make`, and execute the resulting elf-file. Further
|
* application's Makefile, call `make`, and execute the resulting elf-file. Further
|
||||||
* documentation about the native port can be found in `cpu/native/README`.
|
* documentation about the native port can be found in `cpu/native/README`.
|
||||||
*
|
*
|
||||||
* \subsection structure Structure
|
* \subsection structure Structure
|
||||||
@ -68,15 +68,15 @@
|
|||||||
* ####The build system
|
* ####The build system
|
||||||
*
|
*
|
||||||
* RIOT uses GNU make as build system. The simplest way to compile and link a
|
* RIOT uses GNU make as build system. The simplest way to compile and link a
|
||||||
* project (application or library) with RIOT, is to set up a Makefile providing
|
* application (application or library) with RIOT, is to set up a Makefile providing
|
||||||
* at least the following variables:
|
* at least the following variables:
|
||||||
* * PROJECT
|
* * PROJECT
|
||||||
* * BOARD
|
* * BOARD
|
||||||
* * RIOTBASE
|
* * RIOTBASE
|
||||||
*
|
*
|
||||||
* and an instruction to include the `Makefile.include`, located in RIOT's root
|
* and an instruction to include the `Makefile.include`, located in RIOT's root
|
||||||
* directory. `PROJECT` should contain the (unique) name of your project, `BOARD`
|
* directory. `PROJECT` should contain the (unique) name of your application, `BOARD`
|
||||||
* specifies the platform the project should be built for by default, and
|
* specifies the platform the application should be built for by default, and
|
||||||
* `RIOTBASE` specifies the path to your copy of the RIOT repository (note, that
|
* `RIOTBASE` specifies the path to your copy of the RIOT repository (note, that
|
||||||
* you may want to use `$(CURDIR)` here, to give a relative path). You can use Make's
|
* you may want to use `$(CURDIR)` here, to give a relative path). You can use Make's
|
||||||
* `?=` operator in order to allow overwriting variables from the command line. For
|
* `?=` operator in order to allow overwriting variables from the command line. For
|
||||||
@ -102,10 +102,10 @@
|
|||||||
*
|
*
|
||||||
* ####Including modules
|
* ####Including modules
|
||||||
*
|
*
|
||||||
* By default a RIOT project comprises only the projects' code itself, the kernel,
|
* By default a RIOT application comprises only the applications' code itself, the kernel,
|
||||||
* and platform specific code. In order to use additional modules, such as a
|
* and platform specific code. In order to use additional modules, such as a
|
||||||
* particular device driver or a system library, you have to append the modules'
|
* particular device driver or a system library, you have to append the modules'
|
||||||
* names to the USEMODULE variable. For example, to build a project using the SHT11
|
* names to the USEMODULE variable. For example, to build a application using the SHT11
|
||||||
* temperature sensor and 6LoWPAN network stack, your Makefile needs to contain
|
* temperature sensor and 6LoWPAN network stack, your Makefile needs to contain
|
||||||
* these lines:
|
* these lines:
|
||||||
* \code
|
* \code
|
||||||
@ -124,7 +124,7 @@
|
|||||||
* power mode for the device. The main thread - configured with a default priority
|
* power mode for the device. The main thread - configured with a default priority
|
||||||
* that is right in the middle between the lowest and the highest available
|
* that is right in the middle between the lowest and the highest available
|
||||||
* priority - is the first thread that runs and calls the main function. This
|
* priority - is the first thread that runs and calls the main function. This
|
||||||
* function needs to be defined by the project.
|
* function needs to be defined by the application.
|
||||||
*
|
*
|
||||||
* ####Choosing the right stack size
|
* ####Choosing the right stack size
|
||||||
*
|
*
|
||||||
|
@ -51,7 +51,7 @@ and Telematics group (http://cst.mi.fu-berlin.de).
|
|||||||
#define CC1100_MAX_DATA_LENGTH (58)
|
#define CC1100_MAX_DATA_LENGTH (58)
|
||||||
|
|
||||||
// Define default radio mode to constant RX if no
|
// Define default radio mode to constant RX if no
|
||||||
// project specific setting is available.
|
// application specific setting is available.
|
||||||
#ifndef CC1100_RADIO_MODE
|
#ifndef CC1100_RADIO_MODE
|
||||||
#ifdef MODULE_RPL
|
#ifdef MODULE_RPL
|
||||||
#warning RPL currently works with CC1100_MODE_WOR
|
#warning RPL currently works with CC1100_MODE_WOR
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = ccn-lite-client
|
export PROJECT = ccn-lite-client
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = ccn-lite-relay
|
export PROJECT = ccn-lite-relay
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = default
|
export PROJECT = default
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = hello-world
|
export PROJECT = hello-world
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = ipc_pingpong
|
export PROJECT = ipc_pingpong
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = rpl_udp
|
export PROJECT = rpl_udp
|
||||||
|
|
||||||
# If no BOARD is found in the environment, use this default:
|
# If no BOARD is found in the environment, use this default:
|
||||||
|
@ -2,9 +2,9 @@ This directory provides some porting information for libraries and programs to
|
|||||||
use with RIOT (to build an external module). If you'd like to add a package to
|
use with RIOT (to build an external module). If you'd like to add a package to
|
||||||
RIOT you need to add a directory with the name of your package to this directory.
|
RIOT you need to add a directory with the name of your package to this directory.
|
||||||
Your directory should contain at least two files:
|
Your directory should contain at least two files:
|
||||||
* patch.txt - Your patch of the upstream project of the package to make it
|
* patch.txt - Your patch of the upstream application of the package to make it
|
||||||
build with RIOT
|
build with RIOT
|
||||||
* Makefile - A Makefile describing how to get the upstream project, apply
|
* Makefile - A Makefile describing how to get the upstream application, apply
|
||||||
the patch and how to build the package as a RIOT module.
|
the patch and how to build the package as a RIOT module.
|
||||||
A rough template for several methods of acquiring a package
|
A rough template for several methods of acquiring a package
|
||||||
is provided in Makefile.git, Makefile.http, and Makefile.svn
|
is provided in Makefile.git, Makefile.http, and Makefile.svn
|
@ -1,5 +1,5 @@
|
|||||||
Packages are included to your project as external modules. Thus you only have
|
Packages are included to your application as external modules. Thus you only have
|
||||||
to add the following line to your project (and update your INCLUDE path
|
to add the following line to your application (and update your INCLUDE path
|
||||||
accordingly):
|
accordingly):
|
||||||
|
|
||||||
USEPKG += <pkg_name>
|
USEPKG += <pkg_name>
|
||||||
|
@ -3,8 +3,8 @@
|
|||||||
* @defgroup sys_autoinit Auto-init
|
* @defgroup sys_autoinit Auto-init
|
||||||
* @ingroup sys
|
* @ingroup sys
|
||||||
* @brief Auto initialize modules
|
* @brief Auto initialize modules
|
||||||
* @note This feature can be used by any project by adding auto_init to
|
* @note This feature can be used by any application by adding auto_init to
|
||||||
* USEMODULE in the project's Makefile. auto_init will initialize
|
* USEMODULE in the application's Makefile. auto_init will initialize
|
||||||
* any other included module that does not require a parameter in
|
* any other included module that does not require a parameter in
|
||||||
* its init function, i.e. if the prototype looks like this: void
|
* its init function, i.e. if the prototype looks like this: void
|
||||||
* MODULE_init(void). Most timer modules or simple drivers can be
|
* MODULE_init(void). Most timer modules or simple drivers can be
|
||||||
|
@ -38,7 +38,7 @@ typedef struct shell_t {
|
|||||||
/**
|
/**
|
||||||
* @brief Initialize a shell object
|
* @brief Initialize a shell object
|
||||||
* @param shell Pointer to preallocated shell object
|
* @param shell Pointer to preallocated shell object
|
||||||
* @param shell_commands Pointer to shell command structure. See test_shell project for example.
|
* @param shell_commands Pointer to shell command structure. See test_shell application for example.
|
||||||
* @param shell_buffer_size The size of the shell buffer.
|
* @param shell_buffer_size The size of the shell buffer.
|
||||||
* @param read_char Pointer to input device read function. Should return exactly one byte or block.
|
* @param read_char Pointer to input device read function. Should return exactly one byte or block.
|
||||||
* @param put_char Pointer to output funtion. currently unused, shell code will use printf.
|
* @param put_char Pointer to output funtion. currently unused, shell code will use printf.
|
||||||
|
@ -30,7 +30,7 @@ If this chunk has the default chunk size the next chunk is requested, ...
|
|||||||
If a smaller chunk arrives the user land code prints out the complete file which was requested.
|
If a smaller chunk arrives the user land code prints out the complete file which was requested.
|
||||||
|
|
||||||
To populate the cache type `ccn 100` and `populate`.
|
To populate the cache type `ccn 100` and `populate`.
|
||||||
You can test this functionality by typing `interest /riot/text` in the shell. *See HOWTO.md in the projects directory*.
|
You can test this functionality by typing `interest /riot/text` in the shell. *See HOWTO.md in the applications directory*.
|
||||||
|
|
||||||
### ccn-lite-relay
|
### ccn-lite-relay
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_bloom
|
export PROJECT = test_bloom
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_bloom
|
export PROJECT = test_bloom
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_float
|
export PROJECT = test_float
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_hwtimer
|
export PROJECT = test_hwtimer
|
||||||
|
|
||||||
export BOARD ?= native
|
export BOARD ?= native
|
||||||
|
@ -29,7 +29,7 @@ void callback(void *ptr)
|
|||||||
|
|
||||||
int main(void)
|
int main(void)
|
||||||
{
|
{
|
||||||
puts("hwtimer test project...");
|
puts("hwtimer test application...");
|
||||||
|
|
||||||
puts("Initializing hwtimer...");
|
puts("Initializing hwtimer...");
|
||||||
hwtimer_init();
|
hwtimer_init();
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# define project name
|
# define application name
|
||||||
export PROJECT = test_hwtimer_spin
|
export PROJECT = test_hwtimer_spin
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_irq
|
export PROJECT = test_irq
|
||||||
#
|
#
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
debug: CFLAGS += -g
|
debug: CFLAGS += -g
|
||||||
debug: CFLAGS += -DENABLE_DEBUG
|
debug: CFLAGS += -DENABLE_DEBUG
|
||||||
|
|
||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_nativenet
|
export PROJECT = test_nativenet
|
||||||
#
|
#
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
#### ../../boards for board definitions (if you have one or more)
|
#### ../../boards for board definitions (if you have one or more)
|
||||||
####
|
####
|
||||||
|
|
||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT =test_pnet
|
export PROJECT =test_pnet
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_semaphore
|
export PROJECT = test_semaphore
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_sha256
|
export PROJECT = test_sha256
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_shell
|
export PROJECT = test_shell
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
This project shows how to use own or the system shell commands. In order to use
|
This application shows how to use own or the system shell commands. In order to use
|
||||||
the system shell commands:
|
the system shell commands:
|
||||||
|
|
||||||
1. Additionally to the module: shell, shell_commands and posix,
|
1. Additionally to the module: shell, shell_commands and posix,
|
||||||
the module for the corresponding system command is to include, e.g.
|
the module for the corresponding system command is to include, e.g.
|
||||||
module ps for the ps command (cf. the Makefile in the project root
|
module ps for the ps command (cf. the Makefile in the application root
|
||||||
directory).
|
directory).
|
||||||
2. The shell must be initialized as follows:
|
2. The shell must be initialized as follows:
|
||||||
2.1 shell_t sys_shell;
|
2.1 shell_t sys_shell;
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_thread_basic
|
export PROJECT = test_thread_basic
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_thread_exit
|
export PROJECT = test_thread_exit
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_thread_msg
|
export PROJECT = test_thread_msg
|
||||||
|
|
||||||
export BOARD ?= native
|
export BOARD ?= native
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# name of your project
|
# name of your application
|
||||||
export PROJECT = test_vtimer_msg
|
export PROJECT = test_vtimer_msg
|
||||||
|
|
||||||
# for easy switching of boards
|
# for easy switching of boards
|
||||||
|
Loading…
Reference in New Issue
Block a user