diff options
Diffstat (limited to 'tools/docker_rbclient/README')
-rw-r--r-- | tools/docker_rbclient/README | 35 |
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 @@ | |||
1 | This directory builds a Docker container image for a rockbox build | ||
2 | client with all toolchains except android. | ||
3 | |||
4 | There is a pre-built client available as built1n/rbclient on Docker | ||
5 | Hub if you would like to avoid having to build all the toolchains. See | ||
6 | the Docker documentation on how to pull and run it. | ||
7 | |||
8 | To build from scratch: | ||
9 | |||
10 | 1. Make sure you have Docker installed and running. | ||
11 | |||
12 | 2. Run: | ||
13 | |||
14 | docker build . -t myclient | ||
15 | |||
16 | This will build the image and tag it as `myclient.' | ||
17 | |||
18 | 3. 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 | |||
30 | It is also possible to pull straight from Docker Hub. Run: | ||
31 | |||
32 | docker pull built1n/rbclient | ||
33 | |||
34 | Then you can use all the commands above, with `myclient' replaced with | ||
35 | `built1n/rbclient'. \ No newline at end of file | ||