diff options
| -rw-r--r-- | README.md | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/README.md b/README.md index 89dcaa3..ce1c8e9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Black Shades -In Black Shades you control a psychic bodyguard, and try to protect the VIP +In *Black Shades* you control a psychic bodyguard, and try to protect the VIP (dressed in white) from a horde of zombies, snipers and other assorted would-be assassins. @@ -16,15 +16,39 @@ would-be assassins. disarming them, tackling the VIP out of the line of fire, or any combination of the above +## Installation + +*Black Shades* requires [GLFW], [GLU], [libsndfile], [OpenAL Soft] and [Zig]. +Until Zig reaches 1.0, the game will target the language latest minor release. +To build and install the game to `$prefix`, run: + + zig build -Drelease-fast --prefix $prefix install + +## Contributing + +For development, `zig build run` may be preferred for faster compilation. +Patches should be sent to [~cnx/blackshades@lists.sr.ht][mailing list] +using [git send-email] with the following configurations: + + git config sendemail.to '~cnx/blackshades@lists.sr.ht' + git config format.subjectPrefix 'PATCH blackshades' + ## Copying  -Black Shades is free software: you can redistribute it and/or modify +*Black Shades* is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Please refer to the project's wiki for the complete list of [credits]. +[GLFW]: https://glfw.org +[GLU]: https://gitlab.freedesktop.org/mesa/glu +[libsndfile]: https://libsndfile.github.io/libsndfile +[OpenAL Soft]: https://openal-soft.org +[Zig]: https://ziglang.org +[mailing list]: https://lists.sr.ht/~cnx/blackshades +[git send-email]: https://git-send-email.io [credits]: https://man.sr.ht/~cnx/blackshades/credits.md |