aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorJohan Brandhorst <[email protected]>2018-10-20 23:56:37 +0100
committerJohan Brandhorst <[email protected]>2018-10-21 00:28:18 +0100
commit97caabb8c277f8bdddadc594b3a8f284405b925a (patch)
tree9206a0c14e7be680b419acca2274861f2046f53c /docs
parent3d644e6ea88cb1593c4511b78b6f91e12accc565 (diff)
downloadtinygo-97caabb8c277f8bdddadc594b3a8f284405b925a.tar.gz
tinygo-97caabb8c277f8bdddadc594b3a8f284405b925a.zip
Add Dockerfile
Diffstat (limited to 'docs')
-rw-r--r--docs/docker.rst14
-rw-r--r--docs/index.rst1
2 files changed, 15 insertions, 0 deletions
diff --git a/docs/docker.rst b/docs/docker.rst
new file mode 100644
index 000000000..a11cbb5cf
--- /dev/null
+++ b/docs/docker.rst
@@ -0,0 +1,14 @@
+.. docker:
+
+.. highlight:: none
+
+Using with Docker
+=================
+
+A docker container exists for easy access to the ``tinygo`` CLI.
+For example, to compile the blinky example from the root of the repository::
+
+ docker run --rm -v $(pwd):/src tinygo/tinygo build -o /src/blinky.elf -target arduino /src/examples/blinky
+
+Note that you cannot run ``tinygo flash`` from inside the docker container,
+so it is less useful for microcontroller development.
diff --git a/docs/index.rst b/docs/index.rst
index 50bb0618c..a755c96f7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,6 +12,7 @@ Contents:
:maxdepth: 2
installation
+ docker
targets
microcontrollers
faq