diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e204c9 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +

+ ProgressQuest +

+ +Relive the great adventure… this time in the terminal realm! + +- Progress Quest site: http://progressquest.com/ +- Online version: http://progressquest.com/play/ +- Original version: https://bitbucket.org/grumdrig/pq + +## Features + +- Saves (with backups) to `$XDG_CONFIG_HOME/pqcli/save.dat` +- Clean terminal interface + - Smooth progress bars using UTF-8 block characters + - Scrollable list boxes +- Faithful port of the game logic +- Ideal to run on your server + +## How it looks like + +![20181106_001341_mjt](https://user-images.githubusercontent.com/1045476/48032665-d616f300-e158-11e8-8978-4ee3a69e44f8.png) + +## How to install + +If you have Python 3.7, just run `pip install --user pqcli` and you're good to go! +Then type `pqcli` to run the game. + +In case if you want to use the git version, the process is just a little bit +more complex: + +```console +$ git clone https://github.com/rr-/pq-cli.git +$ cd pq-cli +$ pip install --user . +```