FSAE Model Year 2016

Welcome to the FSAE MY16 codebase! There is actually no real code in this specific repository; rather, this contains the structure of files and libraries necessary to conform to the Bare Arduino Project specification. This framework allows nice things like upload using make and having live code compilation on your editor of choice, and I highly recommend it for any non-trivial Arduino projects you might make in the future.

Follow the instructions below to start devving! For newbies, I recommend using the Arduino IDE for now since it is easy to use and you don't need to mess with the command line; as you become more proficient and develop a favorite text editor, I recommend reading about how to use make and make upload to compile and run your code without needing to be in the Arduino editor.

Arduino-IDE instructions are given first, and instructions for the more advanced users are below. Please create an issue for this repository if any part of this documentation is incorrect, or even better make a pull request to fix it!

Basic Instructions:

1. Create a folder for this project in a memorable place.

2. Install git if you haven't already. Git is a version control system that makes it easy for multiple people to collaborate on a large codebase. Think Dropbox shared folders or the MechE's EPDM, but 100x better and allowing for things like merging simultaneous changes and viewing different branches. If you're Course 6 at MIT, you will definitely use this in many of your classes so it's worth learning now!

   • The details of git are a bit out of scope for this readme, but I highly recommend reading this link to learn more about why we use git and why it is awesome.

3. Clone this repository to the folder you created in step 1.

4. Install the Arduino IDE. The version shouldn't matter, so just use the most recent one, but let me know if there is a problem with it!

5. You should see a folder called Arduino located somewhere in your Documents or My Documents folder, with a subfolder called libraries. Copy all folders from the lib folder of this repository (the one you just cloned) to the Arduino/libraries in your Documents folder.

6. Open the /src folder from the cloned repository, clone any of the MY16_* projects that you care about from the MITMotorsports organization, and open their associated .ino files in the Arduino IDE.

   • When cloning a repository, you should place it inside a folder (under /src/) with the same name as the .ino file.
   • So, if your project was located at /Users/racecar_driver/FSAE/MY16, and you wanted to edit the MY16_VCU project, you would first see that the .ino file was Vcu.ino and you would want to locate it at /Users/racecar_driver/FSAE/MY16/src/Vcu/Vcu.ino. Casing matters. Note that all of the .cpp and .h files should be at the same level as the .ino file.
   • Ignore any repositories that are marked as DEPRECATED; we don't want to pay github for private repos but we also don't want to just blow away old code, so this is our somewhat unprofessional solution.

7. Install Cpputest using whatever installation method you prefer (I recommend Homebrew if you are using a mac). This will allow you to run our tests for the Arduino projects (Dash and VCU).

8. Follow the specific instructions for each sub-repository (see the README file on the sub-repository's github) to configure the Arduino IDE for the particular project.