From cc96464317a8e5f9ece77ca7872fcaa0a7011636 Mon Sep 17 00:00:00 2001 From: Thomas Johnstone Date: Mon, 29 Jul 2024 09:38:56 +1000 Subject: [PATCH] Add prerequisites step and note about Windows in build instructions --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 969fca2..50bbcb4 100644 --- a/README.md +++ b/README.md @@ -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