aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0515b54
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# trimui toolchain Docker image
+
+## Installation
+
+With Docker installed and running, `make shell` builds the toolchain and drops into a shell inside the container. The container's `~/workspace` is bound to `./workspace` by default. The toolchain is located at `/opt/trimui-toolchain` inside the container, libraries are in `/opt/trimui-toolchain/arm-buildroot-linux-gnueabi/sysroot/usr/lib/`.
+
+After building the first time, unless a dependency of the image has changed, `make shell` will skip building and drop into the shell.
+
+## Workflow:
+
+- On your host machine, clone repositories into `./workspace` and make changes as usual.
+- In the container shell, find the repository in `~/workspace` and build as usual.