From 0cae7b743c21a361befb0332342e976436e53d16 Mon Sep 17 00:00:00 2001 From: Kevin Townsend Date: Fri, 23 Mar 2012 06:16:31 +0100 Subject: [PATCH] Prep for v1.0.0 --- project/Readme.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 project/Readme.md diff --git a/project/Readme.md b/project/Readme.md new file mode 100644 index 0000000..f52d8e0 --- /dev/null +++ b/project/Readme.md @@ -0,0 +1,34 @@ +# Project Folder + +All project-specific files should be stored in the /project folder to try to +keep the generic HW-level code and drivers seperate from the business logic +of your individual project. This makes it easier to reuse your code in other +projects, and also update the drivers and HW-level code if newer version of +these common-files become available. + +# FOLDERS + +## commands/ + +Code to implements specific commands for the command-line interface. Requires +CFG_INTERFACE to be enabled in projectconfig.h. Generally, each command will +be stored in a seperate file(ex.: "command/cmd_hello.c"), though this isn't a +strict requirement and you may wish to store multiple related commands in one +.c file, such as 'cmds_graphics.c' etc. + +## documentation/ + +Project-specific documentation is stored here + +# FILES + +## cmd_tbl.h + +Contains the master command list for the command-line interface if +CFG_INTERFACE is enabled in projectconfig.h. All commands must be present +in this list to be properly handled by the CLI. + +## commands.c + +Common helper functions for the command-line interface. + -- 2.20.1