aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsadbeast <sadbeast@sadbeast.com>2024-06-23 15:36:59 -0700
committersadbeast <sadbeast@sadbeast.com>2024-07-13 21:58:23 -0700
commit8d018d996c1eddb882dc64ebbd228bb0135944f3 (patch)
treed01956546a77dbae33357c9a5d174f511ac9b282 /README.md
downloadteamdraft-8d018d996c1eddb882dc64ebbd228bb0135944f3.tar.gz
teamdraft-8d018d996c1eddb882dc64ebbd228bb0135944f3.tar.bz2
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..61ca9dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Team Draft Website
+
+The website for [teamdraft.net](https://teamdraft.net).
+
+## Building & Running
+
+It's a Zig project:
+
+`zig build run`
+
+### Nix Flake
+
+It's got one!
+
+```bash
+nix develop
+```
+or
+
+```bash
+direnv allow
+```
+
+## Acknowledgements
+
+Most of the structure of the code was taken from [aolium-api](https://github.com/karlseguin/aolium-api).