diff --git a/README.md b/README.md index 6393f1d57..e3ef4e418 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Clone our [monad-linux][] source from Visual Studio Online. We use the `develop` git clone -b develop --recursive https://msostc.visualstudio.com/DefaultCollection/PS/_git/monad-linux ``` -When checking out a commit (or pulling in commits), you need to update all the submodules too. +When checking out a commit (or pulling in commits), you **must** update all the submodules too. Not doing so is the cause of many headaches. ```sh git submodule update --init --recursive @@ -103,6 +103,8 @@ We have an [automated build repository][] on the Docker Hub that provisions an i Using this image amounts to running an ephemeral container with the local source code mounted as a shared volume, which is precisely what `build.sh` does (as well as pass on command-line arguments). If the `andschwa/magrathea` image is not already present, it is automatically pulled from the Hub. +This is what `build.sh` looks like (there is no need to run this command manually): + ```sh docker run --rm --interactive --tty --volume /absolute/path/to/monad-linux/:/opt/monad --workdir /opt/monad/scripts andschwa/magrathea make run ``` diff --git a/scripts/build.sh b/scripts/build.sh index c9063900c..72efc2d61 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -1,4 +1,4 @@ #!/usr/bin/env sh # Docker requires the volume path to be absolute... so we resolve it ourselves. -docker run --rm --interactive --tty --volume $(dirname $(pwd))/:/opt/monad --workdir /opt/monad/scripts andschwa/magrathea $@ +docker run --rm --interactive --tty --volume $(dirname $(pwd))/:/opt/monad --workdir /opt/monad/scripts andschwa/magrathea:latest $@