Update README.md
This commit is contained in:
parent
18bd7598c1
commit
d7ce19dfa6
18
README.md
18
README.md
@ -15,15 +15,17 @@ In the meantime take a moment to listen to the music of *Die Streuner*:
|
|||||||
|
|
||||||
![Screenshot](screenshot.png)
|
![Screenshot](screenshot.png)
|
||||||
|
|
||||||
|
# Usage
|
||||||
Use arrow keys for movement and enter to get rid of dialogs (for movement w, a, s, d & h, j, k, l works too).
|
Use arrow keys for movement and enter to get rid of dialogs (for movement w, a, s, d & h, j, k, l works too).
|
||||||
|
|
||||||
|
# Downloads
|
||||||
You can download the automatic builds from the [Pipeline](https://gitlab.com/thallian/streuner-game/pipelines) section.
|
You can download the automatic builds from the [Pipeline](https://gitlab.com/thallian/streuner-game/pipelines) section.
|
||||||
|
|
||||||
|
# Building
|
||||||
You can either build it locally (mostly for development) or with docker (for distribution).
|
You can either build it locally (mostly for development) or with docker (for distribution).
|
||||||
|
|
||||||
# Local Building
|
## Local Building
|
||||||
## Prerequisites
|
### Prerequisites
|
||||||
- [Löve](https://love2d.org/)
|
- [Löve](https://love2d.org/)
|
||||||
- make
|
- make
|
||||||
- zip
|
- zip
|
||||||
@ -32,20 +34,20 @@ You can either build it locally (mostly for development) or with docker (for dis
|
|||||||
- awk
|
- awk
|
||||||
- ps
|
- ps
|
||||||
|
|
||||||
## Usage
|
### Usage
|
||||||
```
|
```
|
||||||
make run
|
make run
|
||||||
```
|
```
|
||||||
|
|
||||||
# Docker Building
|
## Docker Building
|
||||||
|
|
||||||
Uses [docker](https://hub.docker.com/r/thallian/love-release/) with [love-release](https://github.com/MisterDA/love-release) to build the different OS packages.
|
Uses [docker](https://hub.docker.com/r/thallian/love-release/) with [love-release](https://github.com/MisterDA/love-release) to build the different OS packages.
|
||||||
|
|
||||||
## Prerequisites
|
### Prerequisites
|
||||||
- [Docker](https://www.docker.com/)
|
- [Docker](https://www.docker.com/)
|
||||||
- make
|
- make
|
||||||
|
|
||||||
## Usage
|
### Usage
|
||||||
```
|
```
|
||||||
make docker
|
make docker
|
||||||
```
|
```
|
||||||
@ -55,7 +57,7 @@ Or you can look up the exact command in the [Makefile](Makefile)
|
|||||||
# Licensation
|
# Licensation
|
||||||
All original code is licensed under the [MPL 2.0](https://www.mozilla.org/MPL/2.0/index.txt).
|
All original code is licensed under the [MPL 2.0](https://www.mozilla.org/MPL/2.0/index.txt).
|
||||||
|
|
||||||
## Libraries
|
# Libraries
|
||||||
- [30log](https://github.com/Yonaba/30log): [MIT](http://opensource.org/licenses/mit-license.php)
|
- [30log](https://github.com/Yonaba/30log): [MIT](http://opensource.org/licenses/mit-license.php)
|
||||||
- [anim8](https://github.com/kikito/anim8): [MIT](http://opensource.org/licenses/mit-license.php)
|
- [anim8](https://github.com/kikito/anim8): [MIT](http://opensource.org/licenses/mit-license.php)
|
||||||
- [bump](https://github.com/kikito/bump.lua): [MIT](http://opensource.org/licenses/mit-license.php)
|
- [bump](https://github.com/kikito/bump.lua): [MIT](http://opensource.org/licenses/mit-license.php)
|
||||||
|
Loading…
Reference in New Issue
Block a user