From 84fdf1fd8f6b0f4c5f87d3fbc203a7a287694997 Mon Sep 17 00:00:00 2001
From: Egor Karavaev <batonius.kirov@gmail.com>
Date: Sat, 24 Jun 2017 12:45:21 +0300
Subject: [PATCH] Add README.md on how to build Redox using docker images.

---
 docker/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 docker/README.md

diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..e5144ac
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,18 @@
+### Building Redox using Docker images with the toolchain
+
+*All you need is git, make, qemu, fuse and docker. The method requires a non-privileged user able to run the `docker` command, which is usually achieved by adding the user to the `docker` group.*
+
+```shell
+git clone https://github.com/redox-os/redox.git ; cd redox #1
+make pull #2
+docker build -t redox docker/ #3
+docker run --cap-add MKNOD --cap-add SYS_ADMIN --device \
+    /dev/fuse -e LOCAL_USER_ID=`id -u` -v `pwd`:/src --rm redox make all #4
+make qemu #5
+```
+To unpack:
+1. Creates a local copy of the repository.
+2. Updates all the submodules in the repository.
+3. Creates a new image in the local image repository named `redox` with Redox toolchain installed. You only need to rebuild the image if you want to update the toolchain.
+4. Builds Redox using the `redox` image. The arguments allow the container to use `fuse` and ensure the resulting files are owned by the current user.
+5. Runs Redox.