Add information

HackTheMidlands · Sep 29, 2020 · 9152ddd · 9152ddd
1 parent bc65223
commit 9152ddd
Showing 1 changed file with 48 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,50 @@
 ![](./images/banner.png)
 
-# HackTheMidlands CTF 2020
+This is the repo for all the challenges built for and run at the
+HackTheMidlands 2020 CTF :tada: :tada:
+
+It's also got a whole bunch of other stuff, like CTFd site resources,
+deployment scripts, etc.
+
+Checkout the writeups at the [wiki](https://github.com/jedevc/HackTheMidlandsCTF20/wiki).
+
+Please feel free to play around with all the challenges, use them yourself or
+let them be inspiration for your own challenges.
+
+## Try it yourself
+
+Running and building the challenges assumes a Linux machine along with a
+number of common dependencies.
+
+### Generate challenges
+
+Compile and build all the different challenge files, such as images,
+binaries, etc.
+
+    $ ./ctftool generate
+
+To remove all compiled challenge files:
+
+    $ ./ctftool clean
+
+### Run challenges
+
+Run the docker containers.
+
+    # Set PYTHONPATH to find the ctftool.py utility
+    $ export PYTHONPATH=$PWD/infra
+
+    # Build docker containers
+    $ ./infra/deploy/build.sh
+
+    # Generate the docker-compose configuration
+    $ mkdir -p build
+    $ cp -R deploy/docker-compose/ build/
+    $ ./build/docker-compose/generate.sh
+
+    # Run docker-compose configuration
+    $ (cd build/docker-compose && docker-compose up)
+
+## Deployment
+
+For more information on deployment, see [ctf-infra](https://github.com/jedevc/ctf-infra/).