Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.89 KB

getting-started.md

File metadata and controls

53 lines (30 loc) · 1.89 KB

Getting Started

Information for new members of the Electrical sub-team on how to navigate the electrical system, and setup CAD software and their firmware development environment.


Version Control

We use Git for version control. Follow the instructions here for your operating system to install Git.

setup.sh

This script lets you set up all the Elec projects in their own subdirectories. It sets up each compatible repository so it ensures your Altium libraries are up to date when you push.

In a Git Bash window, run ./setup.sh from your clone of this repository. This will download all the projects and you can begin working on them.

For more details on the version control setup, see repo-organization.

(Optional) Git Configurations

This is optional, but very useful and timesaving configurations.

Aliases

See Hannah's aliases for recommended git aliases.

Core

Define your editor.

Since different operating systems use different conventions for line-ending and carriage-return characters, a convention must be defined. See information in the core.autocrlf section of the Git configuration page.

[core]
    editor = code --wait
    autocrlf = input

CAD Software

To view or create any schematics and PCBs, you must first install CAD software for schematic capture and PCB layout. Follow the instructions in the CAD software tutorial to get set up.

Electronics

To become acquainted with the electrical system, read through the board overview document. The document provides a detailed overview of all the PCBs and their functionality.

LED Patterns

To learn about the purposes of our different LED colours and patterns, read the LED patterns document.