Skip to content

Commit 5c63160

Browse files
committed
Docs: Minor update to the README.
1 parent 4b46212 commit 5c63160

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ Docker image with the micro:bit toolchain.
44

55
![docker-microbit](https://user-images.githubusercontent.com/4189262/99010611-3445f000-2542-11eb-90d8-0983d37de762.png)
66

7-
Useful to be able to compile C/C++ programmes using DAL or CODAL.
8-
This includes projects like MicroPython.
7+
Useful to be able to compile C/C++ programmes using the DAL or CODAL micro:bit
8+
runtime, which includes projects like MicroPython. It can also be used to build
9+
the DAPLink project for the micro:bit interface chip.
910

1011
Also includes a Docker image ready to be used with
1112
[GitHub Codespaces](https://github.com/features/codespaces) and build your
@@ -25,7 +26,7 @@ docker pull ghcr.io/carlosperate/microbit-toolchain:latest
2526
```
2627

2728
You can find more info about the image here:
28-
https://github.com/users/carlosperate/packages/container/package/microbit-toolchain
29+
https://github.com/carlosperate/docker-microbit-toolchain/pkgs/container/microbit-toolchain
2930

3031
You can run this Docker image to build your project with a command like this:
3132

@@ -111,7 +112,7 @@ $ cd DAPLink
111112
$ git checkout -b develop origin/develop
112113
# Install the Python dependencies in a venv saved in the project directory
113114
$ docker run -v $(pwd):/home --rm ghcr.io/carlosperate/microbit-toolchain:latest bash -c "pip install virtualenv && virtualenv venv && source venv/bin/activate && pip install -r requirements.txt"
114-
# Install the Python dependencies inside the docker image and run the build script
115+
# Activate the Python virtual environment and run the build script
115116
$ docker run -v $(pwd):/home --rm ghcr.io/carlosperate/microbit-toolchain:latest bash -c "source venv/bin/activate && python tools/progen_compile.py -t make_gcc_arm kl27z_microbit_if"
116117
```
117118

0 commit comments

Comments
 (0)