summaryrefslogtreecommitdiffstats
path: root/arch/DockerBuildEnvironment/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'arch/DockerBuildEnvironment/README.md')
-rw-r--r--arch/DockerBuildEnvironment/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/arch/DockerBuildEnvironment/README.md b/arch/DockerBuildEnvironment/README.md
new file mode 100644
index 000000000..325616f3d
--- /dev/null
+++ b/arch/DockerBuildEnvironment/README.md
@@ -0,0 +1,23 @@
+# Trinity Build Environment Docker Image
+
+## How to build
+All you need to do is run
+```
+docker build
+```
+
+in this directory and it will create an image for building Trinity with.
+
+## Using the docker image
+Here is an example way to run docker for building trinity
+```
+docker run -it --rm -v `pwd`:/tmp/src <finalimageid>
+```
+
+Once running just run
+```
+su - dev
+```
+To enter a non-root user
+
+This will mount your source directory in /tmp/src where you can run ./build.