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

1 files changed, 50 insertions, 0 deletions

diff --git a/apps/README.txt b/apps/README.txt
new file mode 100644
index 000000000..e7bb212e4
--- /dev/null
+++ b/apps/README.txt
@@ -0,0 +1,50 @@
+
+Application Folder
+==================
+
+This folder provides various applications found in sub-directories.
+
+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 
+	
+NuttShell provides transparent method of invoking the command, when the
+following option is enabled:
+	CONFIG_EXAMPLES_NSH_BUILTIN_APPS=y
+
+To select which application to be included in the build process set your
+preferences the nuttx/.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
+	
+When the user defines an option:
+	CONFIG_BUILTIN_APP_START=<application name>
+	
+Note that application name must be provided in ".." as: "hello"
+for the hello application, which starts the immediately after system 
+starts:
+	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