Merge pull request #579 from tsoding/541

[nothing.git] / README.md

diff --git a/README.md b/README.md
index bd497a2689d2d39f508b54b2425211be09878732..811cab586ca189461bead5996a5fc04a3c8481f6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,10 +5,50 @@
 ![](https://i.imgur.com/7mECYKU.gif)
 ![](https://i.imgur.com/ABcJqB5.gif)
 
+## Dependencies
+
+- [gcc]
+- [cmake]
+- [python3]
+- [libsdl2-dev]
+- [libsdl2-mixer-dev]
+- [inotify-tools]
+
+### Ubuntu
+
+```console
+$ sudo apt-get install gcc cmake libsdl2-dev libsdl2-mixer-dev python3 inotify-tools
+```
+
+### MacOS
+
+```console
+$ brew install gcc cmake sdl2 sdl2_mixer python3
+```
+
+### NixOS
+
+For [NixOS] we have a development environment defined in [default.nix]
+with all of the required dependencies. You can enter the environment
+with `nix-shell` command:
+
+```console
+$ nix-shell
+```
+
+### Arch Linux
+
+```console
+$ sudo pacman -S gcc cmake sdl2 sdl2_mixer python inotify-tools
+```
+
+### Windows
+
+See [Build on Windows][build-on-windows] section.
+
 ## Quick Start
 
 ```console
-$ nix-shell              # Only on NixOS
 $ mkdir build
 $ cd build/
 $ cmake ..
@@ -21,17 +61,33 @@ $ ./nothing_test
 
 ### Game
 
-| Key | Action             |
-|-----|--------------------|
-| `d` | Move to the right  |
-| `a` | Move to the left   |
-| `c` | Open debug console |
+#### Keyboard
+
+| Key     | Action                                                      |
+|---------|-------------------------------------------------------------|
+| `d`     | Move to the right                                           |
+| `a`     | Move to the left                                            |
+| `SPACE` | Jump                                                        |
+| `c`     | Open debug console                                          |
+| `r`     | Reload the current level including the Player's position    |
+| `q`     | Reload the current level preserving the Player's position   |
+| `p`     | Toggle game pause                                           |
+| `l`     | Toggle transparency on objects. Useful for debugging levels |
+
+#### Gamepad
+
+| Button       | Action                 |
+|--------------|------------------------|
+| `Left Stick` | Movement of the Player |
+| `1`          | Jump                   |
 
-### Console
+### Consolé
 
-| Key   | Action       |
-|-------|--------------|
-| `ESC` | Exit console |
+| Key       | Action                   |
+|-----------|--------------------------|
+| `ESC`     | Exit console             |
+| `Enter`   | Evaluate the expression  |
+| `Up/Down` | Traverse console history |
 
 ## Editing Levels
 
@@ -41,11 +97,10 @@ Generally creating a level looks like:
 SVG File -> Custom Level File -> Game
 ```
 
-To convert SVG to the level file install [xqilla] and run
-[svg2rects.xqe] script:
+To convert SVG to the level file and run [svg2rects.py] script:
 
 ```console
-$ xqilla ./devtools/svg2rects.xqe -i <svg-file> -o <level-file>
+$ python3 ./devtools/svg2rects.py -i <svg-file> -o <level-file>
 ```
 
 All of the levels reside in the [./levels/] folder. Use
@@ -120,7 +175,15 @@ You can support my work via
 [conan]: https://www.conan.io/
 [conan-sdl2]: https://bintray.com/conan/conan-transit/SDL2%3Alasote/2.0.5%3Astable
 [visual-studio]: https://www.visualstudio.com/
-[xqilla]: http://xqilla.sourceforge.net/HomePage
-[svg2rects.xqe]: ./devtools/svg2rects.xqe
+[svg2rects.py]: ./devtools/svg2rects.py
 [./levels/]: ./levels/
 [./levels/Makefile]: ./levels/Makefile
+[gcc]: https://gcc.gnu.org/
+[cmake]: https://cmake.org/
+[libsdl2-dev]: https://www.libsdl.org/
+[libsdl2-mixer-dev]: https://www.libsdl.org/projects/SDL_mixer/
+[python3]: https://www.python.org/
+[NixOS]: https://nixos.org/
+[default.nix]: ./default.nix
+[build-on-windows]: #build-on-windows
+[inotify-tools]: https://github.com/rvoicilas/inotify-tools