Merge pull request #6 from dihm/dockerize_build

Dockerize the build

Author: dihm

CMakeLists.txt

@@ -1,33 +1,11 @@
 cmake_minimum_required(VERSION 3.13)
 
-set(PICO_SDK_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../pico-sdk)
-
 include(pico_sdk_import.cmake)
 
-project(prawn_do_project C CXX ASM)
+project(prawn_do C CXX ASM)
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_CXX_STANDARD 17)
 pico_sdk_init()
 
-add_executable(prawn_do_project
-        prawn_do.c
-		fast_serial.c
-        )
-
-pico_generate_pio_header(prawn_do_project
-${CMAKE_CURRENT_LIST_DIR}/prawn_do.pio
-)
-
-target_include_directories(prawn_do_project PUBLIC ${CMAKE_CURRENT_LIST_DIR})
-
-target_link_libraries(prawn_do_project
-    pico_multicore
-    pico_stdlib
-    pico_unique_id
-    hardware_dma
-    hardware_pio
-    tinyusb_device
-    tinyusb_board
-)
-
-pico_add_extra_outputs(prawn_do_project)
+# add project directory
+add_subdirectory(prawn_do)

README.md

@@ -106,3 +106,22 @@ end\n
 
 <img width="470" alt="documentation" src="https://github.com/pmiller2022/prawn_digital_output/assets/75953337/932b784f-346f-4598-8679-b857578e0291">
 
+## Compiling the firmware
+
+If you want to make changes to the firmware, or want to compile it yourself (because you don't trust binary blobs from the internet), we provide a docker configuration to help you do that.
+
+1. Install docker desktop and make sure it is running (if you are on Windows, you may have to mess around a bit to get virtualisation working at an operating system level)
+2. Clone this repository
+3. Open a terminal with the current working directory set to the repository root (the `docker-compose.yaml`` file should be there)
+4. Run `docker compose build --pull` to build the docker container
+5. Run `docker compose up` to build the PrawnBlaster firmware.
+
+Step 4 will take a while as it has to build the docker container.
+If it is slow to download packages from the Ubuntu package repositories, consider providing an explicit apt mirror that is fast for you: `docker compose build --pull --build-arg APT_MIRROR="http://azure.archive.ubuntu.com/ubuntu/"`.
+
+If you want to change which version of the pico SDK it builds against, this is set in the `build/docker/Dockerfile` file.
+Just change the git tag of the pico SDK that gets cloned out by git, then rebuild the docker container (see step 4).
+
+Note once the docker container is built, you can run step 5 as many times as you like.
+You do not need to rebuild the container, even if you make changes to the source code.
+You only need to rebuild the docker container if you modify the `build/docker/Dockerfile` file.

build/prawn_do_project.uf2

@@ -0,0 +1,11 @@
+name: prawn_do
+
+services:
+  buildfirmware:
+    build:
+      dockerfile: docker/Dockerfile
+    command: /bin/bash -c 'cmake .. && make'
+    volumes:
+      - .:/prawn_digital_output
+    working_dir: /prawn_digital_output/build
+    init: true

docker-compose.yaml

@@ -0,0 +1,29 @@
+# Fetch ubuntu image
+FROM ubuntu:latest AS base
+# Attempt to auto-detect the best mirror (desn't always work well though)
+ARG APT_MIRROR="mirror://mirrors.ubuntu.com/mirrors.txt"
+# Use this one if you are in Australia
+# ARG APT_MIRROR="http://mirror.aarnet.edu.au/pub/ubuntu/archive/"
+
+# Configure mirror. Pass --build-arg APT_MIRROR=<mirror URL> to set a mirror if this is slow
+RUN sed -i "s#htt[p|ps]://archive.ubuntu.com/ubuntu/#$APT_MIRROR#g" /etc/apt/sources.list
+
+# Install packages
+RUN \
+    apt update && \
+    apt install -y git python3 && \
+    apt install -y cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential
+
+# Install Pico SDK into a new stage
+FROM base as buildtools
+
+RUN \
+    mkdir -p /pico/ && \
+    cd /pico/ && \
+    git clone https://github.com/raspberrypi/pico-sdk.git --branch 1.5.1 && \
+    cd pico-sdk/ && \
+    git submodule update --init && \
+    cd /
+    
+# Set the Pico SDK environment variable
+ENV PICO_SDK_PATH=/pico/pico-sdk/

docker/Dockerfile

@@ -0,0 +1,25 @@
+add_executable(prawn_do
+        prawn_do.c
+		fast_serial.c
+        )
+
+pico_generate_pio_header(prawn_do
+${CMAKE_CURRENT_LIST_DIR}/prawn_do.pio
+)
+
+# add local includes for fast_serial
+target_include_directories(prawn_do PRIVATE ${CMAKE_CURRENT_LIST_DIR})
+
+# pull in pico stdlib
+target_link_libraries(prawn_do
+    pico_multicore
+    pico_stdlib
+    pico_unique_id
+    hardware_dma
+    hardware_pio
+    tinyusb_device
+    tinyusb_board
+)
+
+# create map/bin/hex/uf2 files
+pico_add_extra_outputs(prawn_do)