Simplify the readme
This commit is contained in:
parent
e924e8eb75
commit
a464016aed
1 changed files with 21 additions and 31 deletions
52
README.md
52
README.md
|
|
@ -1,44 +1,34 @@
|
||||||
# PLAYSCII - an ASCII art and game creation tool
|
# playscii
|
||||||
|
|
||||||
Playscii (pronounced play-skee) is an art, animation, and game creation tool.
|
ascii art and animation program
|
||||||
The latest version will always be available here:
|
|
||||||
|
|
||||||
* [http://jp.itch.io/playscii](http://jp.itch.io/playscii)
|
## forked from jp labreton
|
||||||
* [https://heptapod.host/jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii)
|
|
||||||
|
|
||||||
Playscii's main website is here:
|
[jp.itch.io/playscii](https://jp.itch.io/playscii)
|
||||||
|
|
||||||
* [https://jplebreton.com/playscii/](https://jplebreton.com/playscii/)
|
forked from [jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii) (v9.18).
|
||||||
|
|
||||||
## Offline documentation
|
i found this nice interview with him: [cheesetalks.net/jplebreton.php](https://cheesetalks.net/jplebreton.php)
|
||||||
|
|
||||||
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
|
## setup
|
||||||
|
|
||||||
The latest version of the HTML documentation resides here:
|
requires libSDL2 and libSDL2_mixer installed on the system:
|
||||||
|
|
||||||
[https://jplebreton.com/playscii/howto_main.html](https://jplebreton.com/playscii/howto_main.html)
|
```sh
|
||||||
|
# fedora
|
||||||
|
sudo dnf install SDL2 SDL2_mixer
|
||||||
|
|
||||||
## Bugs
|
# debian/ubuntu
|
||||||
|
sudo apt install libsdl2-2.0-0 libsdl2-mixer-2.0-0
|
||||||
|
|
||||||
If you run into any issues with Playscii, please report a bug here:
|
# mac
|
||||||
|
brew install sdl2 sdl2_mixer
|
||||||
|
```
|
||||||
|
|
||||||
[https://heptapod.host/jp-lebreton/playscii/issues](https://heptapod.host/jp-lebreton/playscii/issues)
|
then, with [uv](https://docs.astral.sh/uv/#installation) installed:
|
||||||
|
|
||||||
## Roadmap
|
```sh
|
||||||
|
uv sync
|
||||||
For possible future features see Playscii's Trello:
|
just run
|
||||||
|
```
|
||||||
[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)
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue