From a28909bb70eef8d3dc179df66615a909ab0fc3e8 Mon Sep 17 00:00:00 2001 From: ynerant Date: Mon, 25 Jan 2021 15:04:47 +0100 Subject: [PATCH] Fix Readme --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 48b2220..ac8b13c 100644 --- a/README.md +++ b/README.md @@ -11,31 +11,37 @@ Squirrel Battle is an infinite rogue-like game with randomly generated levels, in which the player controls a squirrel in its quest down in a dungeon, using diverse items to defeat monsters, and trying not to die. -##Installation +## Installation -####Via PyPI : -``` pip install --user squirrel-battle -``` to install +#### Via PyPI : +``` +$ pip install --user squirrel-battle +``` +to install -``` pip install --user --upgrade squirrel-battle -``` to upgrade +``` +$ pip install --user --upgrade squirrel-battle +``` +to upgrade -####Via ArchLinux package : +#### Via ArchLinux package : Download one of these two packages on the AUR : * python-squirrel-battle * python-squirrel-battle-git -####Via Debian package : +#### Via Debian package : Available on our git repository, has a dependency on fonts-noto-color-emoji (to be found in the official Debian repositories). -Run ``` - dpkg -i python3-squirrelbattle_23.14_all.deb -``` after downloading +Run +``` +$ dpkg -i python3-squirrelbattle_23.14_all.deb +``` +after downloading -In all cases, execute via command line : ```squirrel-battle``` +In all cases, execute via command line : `squirrel-battle` -##For first-time players +## For first-time players The game is played in a terminal only, preferably one that supports color, markdown and emojis, but it can be played with only grey levels and relatively classic unicode characters.