From ad1f0291860fb65797e813676f886f2f45bb1052 Mon Sep 17 00:00:00 2001 From: Carly Ho Date: Wed, 20 Mar 2024 13:14:05 -0500 Subject: [PATCH] Add README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1411cbe --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Gemitwee + +Converts [Twee2](https://dan-q.github.io/twee2/documentation.html) markup (either written standalone or exported from [Twine](https://twinery.org)) to [Gemtext](https://geminiprotocol.net/docs/gemtext.gmi) files. + +Note that this does not and cannot support: stylesheets, scripts, macros, variables, generally things that aren't text. The ideal candidate is a game that is completely operated via links. Most Gemini clients don't support images, so I suggest if you want them to convert them to [ASCII art](https://www.asciiart.eu/image-to-ascii). + +If you've used this, let me know via issues/a PR/sending me an email at smallbird@tilde.club and I'll make a list here of Gemitwee games! + +The script is mirrored on Gemini at [gemini://tilde.pink/~smallbird/tweetogemini.gmi](gemini://tilde.pink/~smallbird/tweetogemini.gmi)