From 79116ed071f6fcd694babf05cee60c7cc76987df Mon Sep 17 00:00:00 2001 From: Jared Miller Date: Thu, 12 Feb 2026 21:42:23 -0500 Subject: [PATCH] Simplify the readme --- README.md | 44 -------------------------------------------- README.rst | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 44 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 36f340b..0000000 --- a/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# PLAYSCII - an ASCII art and game creation tool - -Playscii (pronounced play-skee) is an art, animation, and game creation tool. -The latest version will always be available here: - -* [http://jp.itch.io/playscii](http://jp.itch.io/playscii) -* [https://heptapod.host/jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii) - -Playscii's main website is here: - -* [https://jplebreton.com/playscii/](https://jplebreton.com/playscii/) - -## Offline documentation - -Playscii now includes its own HTML documentation, which you can find in the -docs/html/ subfolder of the folder where this README resides. - -## Online documentation - -The latest version of the HTML documentation resides here: - -[https://jplebreton.com/playscii/howto_main.html](https://jplebreton.com/playscii/howto_main.html) - -## Bugs - -If you run into any issues with Playscii, please report a bug here: - -[https://heptapod.host/jp-lebreton/playscii/issues](https://heptapod.host/jp-lebreton/playscii/issues) - -## Roadmap - -For possible future features see Playscii's Trello: - -[https://trello.com/b/BLQBXn5H/playscii](https://trello.com/b/BLQBXn5H/playscii) - -Please don't take anything there as a promise, though. If you'd find something -on there especially valuable, feel free to vote or comment! - -## Contact - -If you've made something cool with Playscii and/or have any suggestions on how -to improve it, please let JP know! - -[https://jplebreton.com/#contact_email](https://jplebreton.com/#contact_email) diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f31897d --- /dev/null +++ b/README.rst @@ -0,0 +1,23 @@ +playscii +======== + +forked from `jp-lebreton/playscii `_ (v9.18). + +setup +----- + +requires libSDL2 and libSDL2_mixer installed on the system:: + + # fedora + sudo dnf install SDL2 SDL2_mixer + + # debian/ubuntu + sudo apt install libsdl2-2.0-0 libsdl2-mixer-2.0-0 + + # mac + brew install sdl2 sdl2_mixer + +then, with `uv `_ installed:: + + uv sync + just run