shmup/playscii
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Simplify the readme

Browse source
This commit is contained in:
Jared Miller 2026-02-12 21:42:23 -05:00
parent e924e8eb75
commit 79116ed071
Signed by: shmup
GPG key ID: 22B5C6D66A38B06C
2 changed files with 23 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

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

23
README.rst Normal file
View file

@ -0,0 +1,23 @@
playscii
========
forked from `jp-lebreton/playscii <https://heptapod.host/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 <https://docs.astral.sh/uv/#installation>`_ installed::
uv sync
just run