Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.53 KB

README.md

File metadata and controls

40 lines (32 loc) · 1.53 KB

Tennessee Tech ChemECarTeam Build Status

Find the rules here at AIChE's website. Scroll down and find the Competition Official Rules document.

This is the code for the TTU ChemECar team's microcontroller. It is aimed at being highly adaptable and maintainable, usable with lots of hardware and for years to come.


Commenting and Documentation

  • Comment all the code, lots!
    • Heres the thing, whether it's you or somebody else, they won't know what you were thinking
    • So put lots of indepth comments everywhere
  • All functions should have an explaination at its declaration/definition
 /*
 * <function name> 
 * 
 * Purpose: - <What it does>
 *
 * Pre-conditions - <Anything somebody using this function should know that the function assumes?>
 *
 * Post-conditions - <Anything somebody using this function should know that the function assumes?>
 *
 * Parameters - <What the parameters are, explain>
 *
 * Returns - <What value is returned and if anything else is done, explain>
* 
*/

Hardware used/Required is listed in our ProjectRequirements, for now


Contacts

Team Captain: Ian Terel, IBterrell42@tntech.edu Electronics and Chassis Leader: Rus Hoffman, RHoffman42@tntech.edu