about summary refs log tree commit diff homepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed77657
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Ziggetty
+
+[Ziggetty](http://ziggetty.terin.ee) is a simple HTTP server for static web sites.
+
+* [Source code](https://git.terinstock.com/plugins/gitiles/ziggetty/)
+* [Open changes](https://git.terinstock.com/q/status:open+project:ziggetty)
+
+Ziggetty is written in the [Zig Programming Language](https://ziglang.org/), and currently
+requires a version compiled from trunk.
+
+## Quick Start
+
+A development build can be built from the source code:
+
+```console
+$ git clone https://git.terinstock.com/ziggetty
+$ zig build-exe main.zig
+$ ./main &
+$ curl http://localhost:8080
+```
+
+Tagged releases, along with binaries, will begin shortly.