(#1193) Move selection clean to game_switch_state

[nothing.git] / README.md

diff --git a/README.md b/README.md
index 541df950ca08dbbe4f3de9081f65db5250798490..ec642c5854920411800da2d30668f67826019a43 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 [![Tsoding](https://img.shields.io/badge/twitch.tv-tsoding-purple?logo=twitch&style=for-the-badge)](https://www.twitch.tv/tsoding)
 [![Build Status](https://travis-ci.org/tsoding/nothing.svg?branch=master)](https://travis-ci.org/tsoding/nothing)
-[![Build status](https://ci.appveyor.com/api/projects/status/gxfgojq4ko98e0g0/branch/master?svg=true)](https://ci.appveyor.com/project/rexim/nothing/branch/master)
+[![Build Status](https://ci.appveyor.com/api/projects/status/gxfgojq4ko98e0g0/branch/master?svg=true)](https://ci.appveyor.com/project/rexim/nothing/branch/master)
+[![Build Status](https://github.com/tsoding/nothing/workflows/CI/badge.svg)](https://github.com/tsoding/nothing/actions)
 
 # Nothing
 
@@ -9,15 +10,14 @@
 
 ## Dependencies
 
-- [gcc]
+- [gcc] or [clang] or [MSVC 2015+][visual-studio]
 - [cmake]
 - [libsdl2-dev]
-- [inotify-tools]
 
 ### Ubuntu
 
 ```console
-$ sudo apt-get install gcc cmake libsdl2-dev inotify-tools libxml2-dev
+$ sudo apt-get install gcc cmake libsdl2-dev
 ```
 
 ### MacOS
@@ -39,7 +39,7 @@ $ nix-shell
 ### Arch Linux
 
 ```console
-$ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2
+$ sudo pacman -S gcc cmake sdl2
 ```
 
 ### Windows
@@ -57,13 +57,21 @@ $ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2
 
 ### Linux
 
+#### CMake
+
 ```console
 $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ cd ../assets/
-$ ../build/nothing
+$ ./nothing
+```
+
+#### SCU
+
+```console
+$ ./build-posix.sh
+$ ./nothing
 ```
 
 ### Windows
@@ -82,8 +90,7 @@ $ ../build/nothing
 > cd build
 > cmake ..
 > cmake --build .
-> cd ../assets/
-> ..\build\nothing
+> .\nothing
 ```
 
 #### MinGW (with MSYS)
@@ -97,8 +104,7 @@ $ rm SDL2-devel-2.0.10-mingw.tar.gz
 $ mkdir build && cd build
 $ cmake .. -G "MSYS Makefiles"
 $ cmake --build .
-$ cd ../assets/
-$ ../build/nothing
+$ ./nothing
 ```
 
 #### MinGW (without MSYS)
@@ -113,8 +119,7 @@ $ ../build/nothing
 > cd build
 > cmake .. -G "MinGW Makefiles"
 > cmake --build .
-> cd ../assets/
-> ..\build\nothing
+> .\nothing
 ```
 
 ## Controls
@@ -123,17 +128,18 @@ $ ../build/nothing
 
 #### 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 |
-| `TAB`   | Switch to Level Editor                                      |
+| 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 |
+| `TAB`    | Switch to Level Editor                                      |
+| `CTRL+q` | Quit the game                                               |
 
 #### Gamepad
 
@@ -172,6 +178,7 @@ You can support my work via
 [./levels/]: ./levels/
 [./levels/Makefile]: ./levels/Makefile
 [gcc]: https://gcc.gnu.org/
+[clang]: https://clang.llvm.org/
 [cmake]: https://cmake.org/
 [libsdl2-dev]: https://www.libsdl.org/
 [NixOS]: https://nixos.org/