summaryrefslogtreecommitdiff
path: root/apps/README
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-03-12 22:09:14 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-03-12 22:09:14 +0000
commitbb4bde4152e4caf8bb4103d843cea25994ef3c12 (patch)
treefe27d490548897aae21c28e3c63187001fc2ec4e /apps/README
parentec6b2a92400bf21f8b501d76b7cae54ac7a41381 (diff)
downloadnuttx-bb4bde4152e4caf8bb4103d843cea25994ef3c12.tar.gz
nuttx-bb4bde4152e4caf8bb4103d843cea25994ef3c12.tar.bz2
nuttx-bb4bde4152e4caf8bb4103d843cea25994ef3c12.zip
Prep for 5.19 releasenuttx-5.19
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3373 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'apps/README')
-rw-r--r--apps/README58
1 files changed, 0 insertions, 58 deletions
diff --git a/apps/README b/apps/README
deleted file mode 100644
index 4ffee90c8..000000000
--- a/apps/README
+++ /dev/null
@@ -1,58 +0,0 @@
-
-Application Folder
-==================
-
-This folder provides various applications that can be enabled in the .config
-file and further provides frame-work to include external user applications
-from the ../apps directory.
-
-Application entry points with their requirements are gathered together in
-this folder, in two files:
- - exec_nuttapp_proto.h Entry points, prototype function
- - exec_nuttapp_list.h Application specific information and requirements
-
-Application information is collected during the make .depend process.
-
-To execute an application function:
- exec_nuttapp() is defined in the include/nuttx/nuttapp.h
-
-Further, builtin applications may be accessed via pseudo file-system found
-under the nuttx/drivers/sbin directory.
-
-NuttShell provides transparent method of invoking the command, when the
-following option is enabled (regardless of sbin pseudo file system):
- CONFIG_EXAMPLES_NSH_BUILTIN_APPS=y
-
-To select which application to be included in the build process set your
-preferences the .config file as:
-
-To include applications under the nuttx apps directory:
- CONFIG_BUILTIN_APPS_NUTTX=y/n
-
-where each application can be controlled as:
- CONFIG_BUILTIN_APPS_<NAME>=y/n
-
-To include applications under the user ../apps directory:
- CONFIG_BUILTIN_APPS_USER=y/n
-
-When the user defines an option: (NOT IMPLEMENTED YET)
- CONFIG_BUILTIN_APP_START=<application name>
-
-then after initialization of the NuttX OS it starts this application
-using the exec_nuttapp() method.
-
-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 enable/disable option in the top file in this directory as:
- ifeq CONFIG_BUILTIN_APPS_<NAME>
- ...