Custom building instructions

[muzkr]

The V2 branch has switched to CMake, but I haven't had time to update the README or refine the Docker-based build infrastructure yet. As a workaround, I'm adding brief build instructions here so those interested in custom builds can get started. Feel free to contribute additional build guidance for other platforms/environments!

Quick links:

• Custom building on Linux
• Build with Docker (x64)

[muzkr]

Custom building on Linux

1. Install toolchain

The following tools are required:

• ARM GCC toolchain (v13 or higher recommended)
• CMake
• Ninja

2. Setup Python env

Requires Python 3.10 or higher, and pip

Create a venv at the project root:

python -m venv .venv

Activate the venv:

source ./.venv/bin/activate

Install dependencies:

pip install -r requirements.txt

The building process is performed under the venv environment!

3. Build!

Modify the Custom preset in CMakePresets.json according to your requirements.

Configure:

cmake -B build/Custom --preset Custom

Build:

cmake --build build/Custom

Then you will find firmware binaries (*.bin, *.elf etc) in build/Custom

[ojfd]

Hello muzkr.
I see you've been very busy lately and have a lot going on ;)
Any chance that you could update docker based build, so that your version could be built here on Github?
Take care and keep up the the good work!
ojfd

[muzkr]

Okay, let's hope it would happen by the next release (expected in early December).

[ojfd]

Thanks, muzkr!
What I ment by docker build was this method https://github.com/muzkr/uv-k5-firmware-custom?tab=readme-ov-file#building
using Codespace. For local, machine based build on a Mac, Docker requires pretty modern OS, which many of us don't have or use. Deliberately. For various reasons. Apple's system integrity protection (a pain in the neck) is one of them.

[muzkr]

Build with Docker (x64)

Clone this repository:

git clone https://github.com/muzkr/uv-k5-firmware-custom.git && cd uv-k5-firmware-custom

Build a docker image:

docker build -f Dockerfile-x64 -t build:latest

Run a container:

docker run -it -v .:/build/src build:latest

Now you are in the command line of the container. The source code is mounted at /build/src. Do your building there. Ref to linux building instructions above

cd /build/src
cmake -B ...