From 9143334ec54a81e2a75ee9be544af9b19c8faf26 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 | 53 +++++++++++++++++------------------------------------ 1 file changed, 17 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 36f340b..8e566ac 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,25 @@ -# PLAYSCII - an ASCII art and game creation tool +# playscii -Playscii (pronounced play-skee) is an art, animation, and game creation tool. -The latest version will always be available here: +forked from [jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii) (v9.18). -* [http://jp.itch.io/playscii](http://jp.itch.io/playscii) -* [https://heptapod.host/jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii) +## setup -Playscii's main website is here: +requires libSDL2 and libSDL2_mixer installed on the system: -* [https://jplebreton.com/playscii/](https://jplebreton.com/playscii/) +```sh +# fedora +sudo dnf install SDL2 SDL2_mixer -## Offline documentation +# debian/ubuntu +sudo apt install libsdl2-2.0-0 libsdl2-mixer-2.0-0 -Playscii now includes its own HTML documentation, which you can find in the -docs/html/ subfolder of the folder where this README resides. +# mac +brew install sdl2 sdl2_mixer +``` -## Online documentation +then, with [uv](https://docs.astral.sh/uv/#installation) installed: -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) +```sh +uv sync +just run +```