smallbird
/
gemitwee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme w/ usage + requirements

This commit is contained in:
Carly Ho 2024-03-20 13:18:08 -05:00
parent ad1f029186
commit 9c2e1146e0
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,3 +7,15 @@ Note that this does not and cannot support: stylesheets, scripts, macros, variab
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)
# Usage
`php gemitwee.php game_file.twee [output_dir]`
If you don't supply an output directory, it'll just output files into the local folder.
# Requirements
* Some kind of command line
* Probably a recent PHP version. I don't think this uses anything spicy but I can't guarantee it working on like PHP 4
* That's it