From eef17371c0753dba908eb3010d449be19b9979a9 Mon Sep 17 00:00:00 2001 From: Miguel Nogueira Date: Wed, 19 Feb 2020 18:34:32 +0100 Subject: [PATCH] --- Installation.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Installation.md diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..7d2cd16 --- /dev/null +++ b/Installation.md @@ -0,0 +1,13 @@ +## Project Installation + +Download the tar or zipball from the repository. +Prepare the vendor folder with ```composer install```. The project doesn't require any additional libraries but it needs Composer for autoloading classes. + +Dump the autoloader: ```composer dump-autoload -o``` + + +Alternatively you can download a pre-prepared release in the Releases menu. + +## Run the Game + +Execute ```php main.php``` in the project directory to start playing. You can use CTRL-C anytime to exit, but the game allows you to leave on your own after you win or lose a game. \ No newline at end of file