Adding documentation and comments

Author: sc2automation

README.md

@@ -2,13 +2,51 @@
 
 A docker image for building and running the StarCraft II API on Linux
 
+This is a work in progress. Contributions welcome!
+
+TODO:
+    * Get unit tests working on s2client-game container
+    * Automate the replay & Battle.net Cache population
+    * Create a combined container for developers (with git, API and game)
+    * Get some compose / swarm examples for doing larger training exercises
+
 # Summary
 
 By downloading and running this you are agreeing to the [StarCraft II AI and Machine Learning License](https://github.com/Blizzard/s2client-proto/blob/dca8b6831a84747c2cd6e0c33d6416e14838d886/DATA_LICENSE)
 
 There are three main components to getting docker image of StarCraft II running
 
 1. Downloading the Linux build and base maps
+
+~~~
+    ./download.sh && ./clone.sh && ./unpack.sh
+~~~
+
 2. Installing replay packs and the Battle.net cache to run hem
-3. Building and running the API interface for running tests
+
+~~~
+TODO
+~~~
+
+3. Building the containers
+
+~~~
+./build-containers.sh
+~~~
+
+
+4. Test the containers
+
+### Build
+
+~~~
+docker run -it s2client-api
+./api-build.sh
+~~~
+
+### Game
+
+~~~
+docker run -d s2client-game
+~~~
 

api-build.sh

@@ -1,4 +1,8 @@
 #!/bin/bash
+
+# This script is intended to be embedded in the build container for
+# automating the CMake / GNU make build process
+
 mkdir -p build
 pushd build
 cmake -G "Unix Makefiles" ..

build-containers.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
 
+# This builds both containers in one shot
+
 docker build . -f Dockerfile.build -t s2client-api
 docker build . -f Dockerfile.game -t s2client-game

clone.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+# This clones a clean copy of the repo
+
 mkdir -p downloads
 pushd downloads
 rm -rf s2client-api

download.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
+
+VERSION=3.16.1
+
+# This downloads zip files for current version 
 mkdir -p downloads/
 pushd downloads
-wget http://blzdistsc2-a.akamaihd.net/Linux/SC2.3.16.1.zip
+wget http://blzdistsc2-a.akamaihd.net/Linux/SC2.${VERSION}.zip
 wget http://blzdistsc2-a.akamaihd.net/MapPacks/Ladder2017Season1.zip
 wget http://blzdistsc2-a.akamaihd.net/MapPacks/Ladder2017Season2.zip
 wget http://blzdistsc2-a.akamaihd.net/MapPacks/Ladder2017Season3.zip

unpack.sh

@@ -1,3 +1,7 @@
+#!/bin/bash
+
+# This unpacks all of the zip files automatically
+
 VERSION=3.16.1
 UNZIP_CMD="unzip -Piagreetotheeula"