Skip to content

Add prerequisites step and note about Windows in build instructions #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomjohnstone wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add prerequisites step and note about Windows in build instructions #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,27 @@ It also remembers the LED state for each computer, so you can pick up exactly ho

To avoid version mismatch and reported path issues when building, the project now bundles minimal pico sdk and tinyusb.

You should be able to build by running:
1. Install CMake (at least version 3.6), and GCC cross compiler:

```
cmake -S . -B build
cmake --build build
```
```
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib g++
```

2. Generate project files:

```
cmake -S . -B build
```

3. Compile code:

```
cmake --build build
```

#### Windows compilation

It is recommended to use the Windows Subsystem for Linux (WSL): https://learn.microsoft.com/en-us/windows/wsl/install. Once installed you can use the same steps above.

## Using pre-built images

Expand Down