project/Readme.md

   1 # Project Folder
   2
   3 All project-specific files should be stored in the /project folder to try to
   4 keep the generic HW-level code and drivers seperate from the business logic
   5 of your individual project.  This makes it easier to reuse your code in other
   6 projects, and also update the drivers and HW-level code if newer version of
   7 these common-files become available.
   8
   9 # FOLDERS
  10
  11 ## commands/
  12
  13 Code to implements specific commands for the command-line interface.  Requires
  14 CFG_INTERFACE to be enabled in projectconfig.h.  Generally, each command will
  15 be stored in a seperate file(ex.: "command/cmd_hello.c"), though this isn't a
  16 strict requirement and you may wish to store multiple related commands in one
  17 .c file, such as 'cmds_graphics.c' etc.
  18
  19 ## documentation/
  20
  21 Project-specific documentation is stored here
  22
  23 # FILES
  24
  25 ## cmd_tbl.h
  26
  27 Contains the master command list for the command-line interface if
  28 CFG_INTERFACE is enabled in projectconfig.h.  All commands must be present
  29 in this list to be properly handled by the CLI.
  30
  31 ## commands.c
  32
  33 Common helper functions for the command-line interface.
  34