From 63a257c2e23876d19e0d9b78c7b92700ba366704 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 14 Apr 2022 03:01:43 +0000 Subject: feat: add hacking steps Also update lines-of-code count. Also, also, the last few commits were made on a six-hour flight... --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3275b98..1d09ba6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Maple A very simple static Gemini server; written within a single file and liberally -spanning 135 lines-of-code. +spanning 152 lines-of-code. ## Usage @@ -37,6 +37,20 @@ field which should be modified is the `ports`, if you have to. 1. Build: `ninja` (requires [Ninja](https://ninja-build.org/)) 2. Run: `out/maple` +### Hacking + +If you decide to tamper with Maple, you should give your commits a test. As +there isn't a test suite yet, feel free to use any of these examples: + +```bash +# Using OpenSSL directly to debug different requests: +$ openssl s_client -ign_eof -quiet -connect localhost:1965 <<< \ +> "gemini://localhost:1965" + +# Using Bollux to debug proper requests... or any client! +$ bollux localhost +``` + ## Capsules using Maple [Add yours!](https://github.com/gemrest/maple/edit/main/README.md) -- cgit v1.2.3