summaryrefslogtreecommitdiff
path: root/tools/docker_rbclient/README
diff options
context:
space:
mode:
authorFranklin Wei <git@fwei.tk>2019-07-21 18:17:37 -0400
committerFranklin Wei <franklin@rockbox.org>2019-07-28 21:13:56 +0200
commit02a69857994afe608cdb08ee2c51e61afa2952c7 (patch)
tree0dc87ad3d79781b427ca6eb35230a03963db9eff /tools/docker_rbclient/README
parent7f9fc20afa3bcff007da941041ceb0c0d84d8fc3 (diff)
downloadrockbox-02a69857994afe608cdb08ee2c51e61afa2952c7.tar.gz
rockbox-02a69857994afe608cdb08ee2c51e61afa2952c7.zip
Add build code for Docker development environment
This simplifies the tedious task of building all the Rockbox toolchains manually by providing a build code for a Docker container image. It's useful for quickly spinning up a build client with just a couple commands and no waiting to compile (though downloading takes a little while). I've built an image as built1n/rbclient on Docker Hub. All toolchains (even the weird ones) are included, except android16. Change-Id: I6b863628ffb397604f59ec6def2f8bb8c8c7185f
Diffstat (limited to 'tools/docker_rbclient/README')
-rw-r--r--tools/docker_rbclient/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/tools/docker_rbclient/README b/tools/docker_rbclient/README
new file mode 100644
index 0000000000..a514e75c28
--- /dev/null
+++ b/tools/docker_rbclient/README
@@ -0,0 +1,35 @@
1This directory builds a Docker container image for a rockbox build
2client with all toolchains except android.
3
4There is a pre-built client available as built1n/rbclient on Docker
5Hub if you would like to avoid having to build all the toolchains. See
6the Docker documentation on how to pull and run it.
7
8To build from scratch:
9
101. Make sure you have Docker installed and running.
11
122. Run:
13
14 docker build . -t myclient
15
16 This will build the image and tag it as `myclient.'
17
183. To run your client:
19
20 docker run -e USER=your username -e PASS=anything -e NAME=clientname \
21 myclient
22
23 You can also run a bash shell interactively by issuing:
24
25 docker run -it myclient bash
26
27 This will drop you into a fully-equiped rockbox development
28 environment.
29
30It is also possible to pull straight from Docker Hub. Run:
31
32 docker pull built1n/rbclient
33
34Then you can use all the commands above, with `myclient' replaced with
35`built1n/rbclient'. \ No newline at end of file