Skip to content

Commit 989cd79

Browse files
committed
Update README.md
1 parent 1f37ffe commit 989cd79

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Raspberry Pi Pico Docker SDK
22

3-
## Run Docker container
3+
Lightweight Raspberry Pi Pico C++ SDK container.
44

5-
```
6-
docker build ./docker --tag pico-sdk
5+
## Pull container from Docker Hub and run
76

8-
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk
7+
The latest version of the image is stored on [Docker Hub](https://hub.docker.com/repository/docker/lukstep/raspberry-pi-pico-sdk/general)
8+
and can be used for container runs.
9+
Commands below show how to run a container, using an image from Docker Hub
10+
```
11+
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev lukstep/raspberry-pi-pico-sdk:latest
912
1013
docker exec -it pico-sdk /bin/sh
1114
```
1215

13-
## Project build
16+
The directory from which the `docker run` command was called will be mounted to /home/dev in the container.
17+
So after attaching to the SDK container you can build your project following the steps:
1418

15-
After attaching to SDK container run the following command to build the project:
1619
```
1720
cd /home/dev
1821
@@ -21,5 +24,19 @@ mkdir build
2124
cd build
2225
2326
cmake .. && make -j4
27+
```
28+
29+
## Build image and run container:
30+
31+
To build your own SDK image, You need to clone this repository and run the following commands:
2432

2533
```
34+
cd raspberry-pi-pico-docker-sdk
35+
36+
docker build . --tag pico-sdk
37+
38+
docker run -d -it --name pico-sdk --mount type=bind,source=${PWD},target=/home/dev pico-sdk
39+
40+
docker exec -it pico-sdk /bin/sh
41+
```
42+

0 commit comments

Comments
 (0)