Remove TODO(#837)

[nothing.git] / README.md

diff --git a/README.md b/README.md
index e06629b7d66ddf18af2576c5a04afd1f44f6a44f..938e709b5ba366d3627df2e7d03633967823fab1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 [![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)
 
 # Nothing
 
@@ -7,30 +8,40 @@
 
 ## Dependencies
 
-<!-- TODO: README deps are outdated -->
-
 - [gcc]
 - [cmake]
 - [libsdl2-dev]
 - [libsdl2-mixer-dev]
-- [xqilla]
 - [inotify-tools]
 
 ### Ubuntu
 
 ```console
-$ sudo apt-get install gcc cmake libsdl2-dev libsdl2-mixer-dev xqilla inotify-tools
+$ sudo apt-get install gcc cmake libsdl2-dev libsdl2-mixer-dev inotify-tools libxml2-dev
 ```
+
+### MacOS
+
+```console
+$ brew install gcc cmake sdl2 sdl2_mixer
+```
+
 ### NixOS
 
 For [NixOS] we have a development environment defined in [default.nix]
 with all of the required dependencies. You can enter the environment
-`nix-shell` command:
+with `nix-shell` command:
 
 ```console
 $ nix-shell
 ```
 
+### Arch Linux
+
+```console
+$ sudo pacman -S gcc cmake sdl2 sdl2_mixer inotify-tools libxml2
+```
+
 ### Windows
 
 See [Build on Windows][build-on-windows] section.
@@ -42,7 +53,7 @@ $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing ../levels/level-01.txt
+$ ./nothing ../levels/
 $ ./nothing_test
 ```
 
@@ -86,15 +97,19 @@ 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 svg2level program:
 
 ```console
-$ xqilla ./devtools/svg2rects.xqe -i <svg-file> -o <level-file>
+$ ./build/svg2level compile <svg-file> <level-file>
 ```
 
 All of the levels reside in the [./levels/] folder. Use
-[./levels/Makefile] to automatically rebuild all levels.
+[./levels/Makefile] to automatically rebuild all levels:
+
+```console
+$ cd levels/     # you must be inside of the `levels/` folder
+$ make
+```
 
 ### Level Editing Workflow
 
@@ -165,14 +180,13 @@ 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/
-[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/
-[xqilla]: http://xqilla.sourceforge.net/HomePage
 [NixOS]: https://nixos.org/
 [default.nix]: ./default.nix
 [build-on-windows]: #build-on-windows