summaryrefslogtreecommitdiff
path: root/clustering/README.md
diff options
context:
space:
mode:
authorJoe Beda <joe.github@bedafamily.com>2015-01-26 13:50:26 -0800
committerJoe Beda <joe.github@bedafamily.com>2015-01-26 15:25:47 -0800
commit050db5a2f886f39b18cfe36ea768976bb91fdf55 (patch)
tree83aca3c1b1e63013273fd921a4579e1a555cba0f /clustering/README.md
parent387b1cb6c62bc61f3cab76b0eba6e201de29e336 (diff)
Add Dockerfile for sequence diagram generation
Diffstat (limited to 'clustering/README.md')
-rw-r--r--clustering/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/clustering/README.md b/clustering/README.md
index 04abb1bc..7e9d79c8 100644
--- a/clustering/README.md
+++ b/clustering/README.md
@@ -7,3 +7,20 @@ pip install seqdiag
```
Just call `make` to regenerate the diagrams.
+
+## Building with Docker
+If you are on a Mac or your pip install is messed up, you can easily build with docker.
+
+```
+make docker
+```
+
+The first run will be slow but things should be fast after that.
+
+To clean up the docker containers that are created (and other cruft that is left around) you can run `make docker-clean`.
+
+If you are using boot2docker and get warnings about clock skew (or if things aren't building for some reason) then you can fix that up with `make fix-clock-skew`.
+
+## Automatically rebuild on file changes
+
+If you have the fswatch utility installed, you can have it monitor the file system and automatically rebuild when files have changed. Just do a `make watch`. \ No newline at end of file