Add README

This commit is contained in:
Carly Ho 2024-03-20 13:14:05 -05:00
parent 0bae60a3f7
commit ad1f029186
1 changed files with 9 additions and 0 deletions

9
README.md Normal file
View File

@ -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)