User Manual

19
9.0.2 In general, module firmware should be developed using a toolchain
provided or recognized by the manufacturer of the microcontroller.
For example, we like the Atmel Studio IDE and avr-gcc for Atmel
processors.
9.0.3 Code should be human-readable and commented well. All global
variables should have comments detailing their purpose and use.
Every function should include comments that detail:
- The purpose of the function
- The meaning of each argument
- The meaning of the return value
- All side-effects of the function
9.0.4 Include a commented heading at the beginning of each source file
that says:
- The name of the file
- The name of the module
- The author (you)
- Date created
9.0.5 Include any necessary information about your compilation and ICE
toolchain in a readme. Include any necessary IDE project and
configuration files, makefile, etc. LB engineers should be able to
open the project, compile, and flash a chip without any
modification.
9.0.6 Include any non-standard libraries necessary for compilation in the
code/src directory.
9.0.7 Add a precompiled hex file to the code/hex directory. This should