aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Terin Stock <terinjokes@gmail.com>2020-01-09 01:41:32 -0800
committerLibravatar Terin Stock <terinjokes@gmail.com>2020-01-09 02:42:03 -0800
commit5df29709c87654a45585fea07672df51eb9d1050 (patch)
tree9f0bd2c29de82e409da451f9fdcace43d1564d2c /README.md
parentziggetty: simple static HTTP server (diff)
downloadziggetty-5df29709c87654a45585fea07672df51eb9d1050.tar.xz
initial version of ziggetty
An initial version of ziggetty, the simple (and currently _too_ simple) HTTP server for static websites. Ziggetty currently responds to all requests with the contents of index.html from the current directory. While this is slightly less than ideal, the basics of a forking server using `sendfile(2)`.
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.