Go to file
patacongo e0d539f2f4 Fix a netutils build issue
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3587 42af7a65-404d-4744-a932-0658087f49c3
2011-05-11 00:27:29 +00:00
examples Pascal now installs in the apps/ directory 2011-05-10 15:50:23 +00:00
include Move nuttx/include/apps to apps/include 2011-05-09 22:21:10 +00:00
interpreters updated README 2011-05-10 18:21:57 +00:00
namedapp Add STM32 FLASH driver 2011-05-07 16:59:20 +00:00
netutils Fix a netutils build issue 2011-05-11 00:27:29 +00:00
nshlib Mostly cosmetic changes from Uros 2011-05-07 19:22:15 +00:00
vsn Mostly cosmetic changes from Uros 2011-05-07 19:22:15 +00:00
ChangeLog.txt Fix a netutils build issue 2011-05-11 00:27:29 +00:00
Make.defs Renamed nuttapp to namedapp; add binfs to nammedapp/ 2011-03-28 13:01:57 +00:00
Makefile Pascal now installs in the apps/ directory 2011-05-10 15:50:23 +00:00
README.txt Remove .built_always 2011-04-01 14:30:43 +00:00

Application Folder
==================

This folder provides various applications found in sub-directories.

Application entry points with their requirements are gathered together in 
in two files:

	- namedapp/namedapp_proto.h	Entry points, prototype function
	- namedapp/namedapp_list.h	Application specific information and requirements

The build occurs in several phases as different build targets are executed:
(1) contex, (2) depend, and (3) default (all). Application information is
collected during the make context build phase.

To execute an application function:

	exec_namedapp() is defined in the nuttx/include/apps/apps.h 
	
NuttShell provides transparent method of invoking the command, when the
following option is enabled:

	CONFIG_NSH_BUILTIN_APPS=y

in the NuttX configuration.

A special configuration file is used to configure which applications
are to be included in the build.  This file is configs/<board>/<configuration>/appconfig.
The existence of the appconfig file in the board configuration directory
is sufficient to enable building of applications.

The appconfig file is copied into the apps/ directory as .config when
NuttX is configured.  .config is included in the toplevel apps/Makefile.
As a minimum, this configuration file must define files to add to the
CONFIGURED_APPS list like:

  CONFIGURED_APPS  += hello poweroff jvm

The form of each entry is <dir>=<dependency> when:

  <dir> is the name of a subdirectory in the apps directory, and

  <dependency> is a make dependency.  This will be "touch"-ed each time
  that the sub-directory is rebuilt.

When the user defines an option:
	CONFIG_BUILTIN_APP_START=<application name>
	
that application shall be invoked immediately after system starts.
Note that application name must be provided in ".." as: "hello", 
will call:
	int hello_main(int argc, char *argv[])

Application skeleton can be found under the hello sub-directory,
which shows how an application can be added to the project. One must
define:

 1. create sub-directory as: appname
 2. provide entry point: appname_main()
 3. set the requirements in the file: Makefile, specially the lines:
	APPNAME		= appname
	PRIORITY	= SCHED_PRIORITY_DEFAULT
	STACKSIZE	= 768
	ASRCS		= asm source file list as a.asm b.asm ...
	CSRCS		= C source file list as foo1.c foo2.c ..

 4. add application in the apps/Makefile