]> git.rm.cloudns.org Git - xonotic/xonotic.git/commitdiff
Added a README.md to provide quick info about the game and community. 21/head
authorz <z@xnz.me>
Fri, 23 Dec 2016 15:02:25 +0000 (10:02 -0500)
committerz <z@xnz.me>
Fri, 23 Dec 2016 15:02:25 +0000 (10:02 -0500)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..90d1d20
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Xonotic
+
+![Xonotic Logo](http://xonotic.org/static/img/xonotic-logo.png)
+
+Xonotic is an addictive, arena-style first person shooter with crisp movement and a wide array of weapons. It combines intuitive mechanics with in-your-face action to elevate your heart rate. Xonotic is and will always be free-to-play. It is available under the [copyleft](https://www.gnu.org/copyleft/)-style [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html) license.
+
+*Please note, [Gitlab](http://gitlab.com/xonotic/) is our home for repositories, issue tracking, wikis, etc. The repositories on GitHub are mirrors of GitLab's unless specified otherwise.*
+
+## Download
+
+### LATEST RELEASE: Xonotic 0.8.1 for Linux, Windows, and Mac
+
+If you're just here to play, you can download Xonotic as a zip package, torrent, or by using one of [these alternative methods](http://xonotic.org/download/).
+
+- [Download as torrent](http://dl.xonotic.org/xonotic-0.8.1.zip.torrent)
+- [Download as zip](http://dl.xonotic.org/xonotic-0.8.1.zip)
+
+No installation required, just unpack and run. Got questions? See the [FAQ](http://xonotic.org/faq) or [live chat](http://xonotic.org/chat/) with us.
+
+**MD5**: f7a9cd8ab68a00336acca164f983b569
+**Package size**: 940M
+
+## Developing
+
+To install from git, [follow this guide](https://gitlab.com/xonotic/xonotic/wikis/Repository_Access). Learn more about the [directory structure here](https://gitlab.com/xonotic/xonotic/wikis/Git), or check out [our project page on GitLab](https://gitlab.com/groups/xonotic) to see development activity and code ([xonotic-data](https://gitlab.com/xonotic/xonotic-data.pk3dir) is where most development takes place).
+
+## Community
+
+The community is primarily active in the [forums](http://forums.xonotic.org/) and IRC, `#xonotic` on either `irc.freenode.net` (developer chat) or `irc.quakenet.org` (player chat).
+
+## Wiki
+
+[Our Gitlab wiki](https://gitlab.com/xonotic/xonotic/wikis/home) has a lot of information related to developing, playing or otherwise contributing to the game.
+
+## License
+
+Distributed under the GPLv2 license. See the [LICENSE](LICENSE) file for more details.