38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
[](https://github.com/Kenwood/InstrumentVisor/actions/workflows/docs_workflow.yml)
|
|
[](https://github.com/Kenwood/InstrumentVisor/actions/workflows/hardware_workflow.yml)
|
|
[](https://github.com/Kenwood/InstrumentVisor/actions/workflows/firmware_workflow.yml)
|
|
|
|
|
|
# InstrumentVisor
|
|
|
|
|
|
|
|
This repo contains all the firmware and hardware for the InstrumentVisor.
|
|
|
|
If you're looking for the latest docs/builds, see our [Releases Page](https://github.com/Kenwood/InstrumentVisor/releases).
|
|
|
|
# Getting Started
|
|
|
|
First, clone this repo (and optionally checkout a branch)
|
|
|
|
```shell
|
|
git clone https://github.com/Kenwood/InstrumentVisor.git
|
|
cd InstrumentVisor
|
|
```
|
|
|
|
# Init Submodules
|
|
|
|
Some libraries and resources are included as submodules, run the following
|
|
command to initialize them before opening the main sch
|
|
|
|
(If you get a missing library error, make sure to do this)
|
|
|
|
```shell
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
|
|
## Project Layout
|
|
|
|
If you want to use this project template for yourself, you can find it [here!](https://github.com/KenwoodFox/Project-Template)
|