add README.md

This commit is contained in:
Markus Küffner
2021-10-17 01:13:41 +02:00
parent eb333c6d94
commit 96485d8728

23
README.md Normal file
View File

@@ -0,0 +1,23 @@
## Building MCU Code
Build the Docker Image
```
docker build \
--file klipper.Dockerfile \
--target mcu \
--tag klipper-mcu \
.
```
Build the mcu binary.
This example mounts an existing build config at `klipper/.config`. One may want to initially create this file via `make menuconfig`
```
docker run \
--rm \
--volume /opt/docker-sparkcube/config/config.udoo:/opt/klipper/.config \
--volume /opt/docker-sparkcube/out:/opt/klipper/out \
--interactive \
--tty \
klipper-mcu \
bash -c "cd /opt/klipper; make"
```