project/Readme.md

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