project/readme.txt

   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/       Code to implements specific commands for the
  12                 command-line interface.  Requires CFG_INTERFACE
  13                 to be enabled in projectconfig.h.  Generally,
  14                 each command will be stored in a seperate file
  15                 (ex.: "command/cmd_hello.c"), though this isn't
  16                 a strict requirement and you may wish to store
  17                 multiple related commands in one .c file, such
  18                 as 'cmds_graphics.c' etc.
  19
  20 documentation/  Project-specific documentation is stored here
  21
  22 FILES
  23 ==============================================================================
  24 cmd_tbl.h       Contains the master command list for the
  25                 command-line interface if CFG_INTERFACE is
  26                 enabled in projectconfig.h.  All commands
  27                 must be present in this list to be properly
  28                 handled by the CLI.
  29
  30 commands.c      Common helper functions for the command-line
  31                 interface.
  32