Skip to content

Latest commit

 

History

History
14 lines (8 loc) · 829 Bytes

README.md

File metadata and controls

14 lines (8 loc) · 829 Bytes
Raw

Typhoon Electronics

The electronics system for Typhoon Streamliner

Organization

There is a folder for each subsystem. Within each subsystem folder are hardware and firmware folders. Put hardware related files into the hardware folder, firmware in the firmware folder. Other folders can be added as needed: for example a media folder is handy for storing pictures related to a project which can be used in documentation.

Conventions

Partly for consistency, partly for functionality; please follow the following conventions:

  • Try to keep folder names to single words and all lowercase
  • Use underscores to separate words in names (e.g. board_rev1). DO NOT USE SPACES! ESPECIALLY FOR FOLDERS CONTAINING CODE! Spaces in file paths may cause issues in compilers and such so best to avoid them entirely.