Template for CASE Project

Created by CASE Board 19/20

This is a template to be used by all projects in CASE. The template contains a folder structure that covers hardware and software projects.

A sample README by fvcproductions can be found here.

A cheatsheet by Adam Pritchard for writing Markdown can be found here

Goals

Write something about the goals of this project and what you want to achieve.
Can be something like this:

- Utilize more advanced control algorithm.
    - Acceleration control
        - Speed trajectory planner
    - MPC - Model Predictive Conrol (*optional*)
- Reach the moon 
    - With two humans at least 
- Added hardware and improvements
    - 2 MW of power 
    - nRF24 communication

Directories

Template
├── document        # Generic document folder
│   ├── datasheet   # Datasheet for hardware components  
├── hardware        
│   ├── cad         # 3D models
│   │   └── stl     # 3D print files
│   ├── pcb         # Schematic, layout and production files
│   │   └── gerber  # Production files
│   │   └── library # Library for project
├── img             
├── simulation      # Matlab + simulink simulations
└── software        # Firmware files

Installation

Here you can write about how you setup the project if there are some

Usage

Here you write how to use the software or hardware. Can be about how you interface with the software, commands, things to know about when trying this project out.

License

This template is created with MIT license and all projects with CASE should have this license.