From 2141978e8cfe82c9213348d95b9c7e955b8916aa Mon Sep 17 00:00:00 2001 From: lukstep Date: Sat, 1 Oct 2022 00:23:26 +0200 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 769d408..dcf3452 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ # Raspberry Pi Pico Docker SDK -## Run Docker container +Lightweight Raspberry Pi Pico C++ SDK container. +## Pull container from Docker Hub and run + +The latest version of the image is stored on [Docker Hub](https://hub.docker.com/repository/docker/lukstep/raspberry-pi-pico-sdk/general) +and can be used for container runs. +Commands below show how to run a container, using an image from Docker Hub ``` -docker build ./docker --tag pico-sdk - -docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk +docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev lukstep/raspberry-pi-pico-sdk:latest docker exec -it pico-sdk /bin/sh ``` -## Project build +The directory from which the `docker run` command was called will be mounted to /home/dev in the container. +So after attaching to the SDK container you can build your project following the steps: -After attaching to SDK container run the following command to build the project: ``` cd /home/dev @@ -21,5 +24,19 @@ mkdir build cd build cmake .. && make -j4 +``` + +## Build image and run container: + +To build your own SDK image, You need to clone this repository and run the following commands: ``` +cd raspberry-pi-pico-docker-sdk + +docker build . --tag pico-sdk + +docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk + +docker exec -it pico-sdk /bin/sh +``` +