From b7e16d006bbfe31e3ebb8ce1f001888ff9b3a8d7 Mon Sep 17 00:00:00 2001 From: Sebastian Hugentobler Date: Mon, 20 Jun 2016 19:23:40 +0200 Subject: [PATCH] update readme --- Makefile | 2 +- README.md | 18 +++++++++++++++--- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index da8feb5..b4911c5 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ ZIP := zip -x \*.tmx \*.xcf LOVE := love NAME := ds_alpha -VERSION := 0.0.1 +VERSION := 0.0.0 CURRENTDIR := $(realpath .) SRCDIR := src diff --git a/README.md b/README.md index 6d21025..8145e3a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ In the meantime take a moment to listen to the music of *Die Streuner*: ![Screenshot](screenshot.png) -# Prerequisites +Use arrow keys for movement and enter to get rid of dialogs (for movement w, a, s, d & h, j, k, l works too). + +# Local Building +## Prerequisites - [Löve](https://love2d.org/) - [Tiled](http://www.mapeditor.org/) (if you want to edit levels) - [GIMP](http://www.gimp.org/) (if you want to edit character sprites) @@ -25,12 +28,21 @@ In the meantime take a moment to listen to the music of *Die Streuner*: - awk - ps -# Usage +## Usage ``` make run ``` -Use arrow keys for movement and enter to get rid of dialogs (for movement w, a, s, d & h, j, k, l works too). +# Docker Building +## Prerequisites +- [Docker](https://www.docker.com/) + +## Usage +``` +make docker +``` + +Or you can look up the exact command in the [Makefile](Makefile) # Licensation All original code is licensed under the [MPL 2.0](https://www.mozilla.org/MPL/2.0/index.txt).