]> git.lizzy.rs Git - nothing.git/blobdiff - README.md
Link TODO(#79)
[nothing.git] / README.md
index 87ac29bc8fcc2b16bd4ac33c7b7921d1edec7d8d..5479bcb0cf18c6a3e5062a933c4503f3e8d99b40 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/tsoding/nothing.svg?branch=master)](https://travis-ci.org/tsoding/nothing)
+
 # Nothing
 
-![](https://i.imgur.com/7J2wLFZ.png)
+![](https://i.imgur.com/TvlQBPb.gif)
 
 ## Quick Start
 
@@ -10,5 +12,44 @@ $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing
+$ ./nothing <level-file>
+```
+
+## Build on Windows
+
+You need to install [conan][] and [Visual Studio 2017][visual-studio].
+
+### Dependencies
+
+Current version of [SDL2/2.0.5@lasote/stable][conan-sdl2] in the conan-transit
+repository is not compatible with the latest conan, so you'll need to install
+it locally from the git repository:
+
+```console
+$ git clone https://github.com/lasote/conan-sdl2.git # temporary, I hope hope hope
+$ cd conan-sdl2
+$ conan export SDL2/2.0.5@lasote/stable
+```
+
+### Building
+
+Execute the following commands inside of the `nothing` directory:
+
+```console
+$ conan install --build missing --install-folder build
+$ cd build
+$ cmake .. -G "Visual Studio 15 2017 Win64"
 ```
+
+After that, build the `build/nothing.sln` file with Visual Studio.
+
+## Support
+
+You can support my work via
+
+- Twitch channel: https://www.twitch.tv/subs/tsoding
+- Patreon: https://www.patreon.com/tsoding
+
+[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/