aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-05-09 09:45:39 +0000
committerFuwn <[email protected]>2022-05-09 09:45:39 +0000
commitbe1612801a46fd19a10034f3fdcda5d731b0587c (patch)
tree566d104c504390f8ed39eb59dea36151d54873b4 /README.md
parentrefactor(maple): move ssl work to function (diff)
parentfix(build): c++20 instead of c++23 wd (diff)
downloadmaple-be1612801a46fd19a10034f3fdcda5d731b0587c.tar.xz
maple-be1612801a46fd19a10034f3fdcda5d731b0587c.zip
Merge branch 'main' of https://github.com/gemrest/maple
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index fbfd0bd..8bbfeb9 100644
--- a/README.md
+++ b/README.md
@@ -76,6 +76,20 @@ field which should be modified is the `ports`, if you have to.
2. Run: `out/maple`, or
`TITAN=1 TITAN_TOKEN=secret TITAN_MAX_SIZE=2048 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)