aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6c4a92b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# potluck-ctf
+
+A [Hoplon][2] web app for [lolctf][4] potluck CTF competitions.
+
+## Dependencies
+
+- java 1.7+
+- [boot][1]
+
+## Usage
+
+1. Start the auto-compiler. In a terminal:
+
+ ```bash
+ $ boot dev
+ ```
+
+2. Go to [http://localhost:8000][3] in your browser.
+
+[1]: https://boot-clj.com
+[2]: https://hoplon.io
+[3]: http://localhost:8000
+[4]: https://lolctf.org