Simplify the readme
This commit is contained in:
parent
fd16a68991
commit
b6e4a719be
1 changed files with 21 additions and 34 deletions
55
README.md
55
README.md
|
|
@ -1,44 +1,31 @@
|
|||
# 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:
|
||||
ascii art and animation program
|
||||
|
||||
* [http://jp.itch.io/playscii](http://jp.itch.io/playscii)
|
||||
* [https://heptapod.host/jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii)
|
||||
## forked from jp labreton
|
||||
|
||||
Playscii's main website is here:
|
||||
- [jp.itch.io/playscii](https://jp.itch.io/playscii)
|
||||
- [jp-lebreton/playscii](https://heptapod.host/jp-lebreton/playscii)
|
||||
- i found this nice interview with him: [cheesetalks.net/jplebreton.php](https://cheesetalks.net/jplebreton.php)
|
||||
|
||||
* [https://jplebreton.com/playscii/](https://jplebreton.com/playscii/)
|
||||
## setup
|
||||
|
||||
## Offline documentation
|
||||
requires libSDL2 and libSDL2_mixer installed on the system:
|
||||
|
||||
Playscii now includes its own HTML documentation, which you can find in the
|
||||
docs/html/ subfolder of the folder where this README resides.
|
||||
```sh
|
||||
# fedora
|
||||
sudo dnf install SDL2 SDL2_mixer
|
||||
|
||||
## Online documentation
|
||||
# debian/ubuntu
|
||||
sudo apt install libsdl2-2.0-0 libsdl2-mixer-2.0-0
|
||||
|
||||
The latest version of the HTML documentation resides here:
|
||||
# mac
|
||||
brew install sdl2 sdl2_mixer
|
||||
```
|
||||
|
||||
[https://jplebreton.com/playscii/howto_main.html](https://jplebreton.com/playscii/howto_main.html)
|
||||
then, with [uv](https://docs.astral.sh/uv/#installation) installed:
|
||||
|
||||
## 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
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue