Skip to content

Commit

Permalink
(README): Add initial installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jcxldn committed Jun 19, 2023
1 parent 2c44d2e commit 0803cb8
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# Genoswitch MP Firmware

## Installation

### Fetch submodules

```shell
git submodule init
git submodule update --depth 1
```

### Toolchain

To build this project, a number of extra tools and libraries are required.

Here are the installation instructions for Linux.

#### Debian-based distros

```shell
sudo apt update
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential libstdc++-arm-none-eabi-newlib python3 git nodejs
```

#### Arch-based distros

~2GB install.

```shell
sudo pacman -S cmake arm-none-eabi-gcc arm-none-eabi-newlib arm-none-eabi-gdb arm-none-eabi-binutils python git nodejs npm
```

## Licensing

The codebase is licensed under MIT.
Expand Down

0 comments on commit 0803cb8

Please sign in to comment.