]> de.git.xonotic.org Git - xonotic/xonotic.git/blobdiff - README.md
Fix macOS SDL2 framework permissions
[xonotic/xonotic.git] / README.md
index 60fb761800e3970d982b8554a394cb90887e1d05..fa6dd7430861ac6065f78a85701f2dce328882a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,47 @@
 # Xonotic
 
-![Xonotic Logo](http://xonotic.org/static/img/xonotic-logo.png)
+![Xonotic Logo](https://xonotic.org/static/img/xonotic_logo_web.svg)
 
-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.
+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.
 
-*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.*
+## License
+
+Xonotic is and will always be free and open source. It is available under the [copyleft](https://www.gnu.org/copyleft/)-style [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.html) license (see the [COPYING](COPYING) file for details).
 
 ## Download
 
-### LATEST RELEASE: Xonotic 0.8.2 for Linux, Windows, and macOS
+Stable releases and related info are available at https://xonotic.org/download
+
+[Beta builds](https://gitlab.com/xonotic/xonotic/-/wikis/Autobuilds) are available at https://beta.xonotic.org/autobuild
+
+The source code included in stable releases and autobuilds can be [compiled as described on the wiki](https://gitlab.com/xonotic/xonotic/-/wikis/Compiling).  This is much "lighter" than a full git clone.
+
+*Please note, [Gitlab](https://gitlab.com/xonotic/) is our home for repositories, issue tracking, wikis, etc. The repositories on GitHub are mirrors of GitLab's unless specified otherwise.*
 
-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/).
+## Community
+
+The community is primarily active in the [forums](https://forums.xonotic.org/) and [chat rooms](https://gitlab.com/xonotic/xonotic/-/wikis/Chat-Rooms).
+
+## Documentation
 
-- [Download as torrent](http://dl.xonotic.org/xonotic-0.8.2.zip.torrent)
-- [Download as zip](http://dl.xonotic.org/xonotic-0.8.2.zip)
+[Halogene's Newbie Guide](https://xonotic.org/guide) gives gameplay and client configuration advice.  
+[Frequently Asked Questions](https://xonotic.org/faq) cover common tech support topics.  
+[The GitLab wiki](https://gitlab.com/xonotic/xonotic/-/wikis/home) has detailed articles and links for many relevant topics.  
+[Command Alias & Cvar Search](https://xonotic.org/tools/cacs) is a web interface to browse Xonotic console features.  
+[Doxygen](https://xonotic.org/doxygen) makes it easier to discover details and dependencies in the code.  
+
+## Developing
 
-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.
+To compile the latest revision 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). Check out [our project page on GitLab](https://gitlab.com/groups/xonotic) to see [development activity](https://gitlab.com/groups/xonotic/-/activity) and code ([xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir) is where most development takes place).
 
-**sha256sum**: a22f7230f486c5825b55cfdadd73399c9b0fae98c9e081dd8ac76eca08359ad5  
-**shasum**: 9a1726e3d0d4e5e23c1e799734397c63e5df6ec9  
-**MD5**: 1bd46c1fb79aae42bb13e74f5a0ff46e  
-**Package size**: 946M  
+Please ensure you've read and understood [CONTRIBUTING.md](CONTRIBUTING.md) before pushing commits or opening merge requests.
 
 ## Contributing
 
-We're mainly looking for help in the following areas:
+We're looking for help in the following areas:
 
+- [Translations](https://www.transifex.com/team-xonotic/xonotic/)
+  - More info [on the wiki](https://gitlab.com/xonotic/xonotic/-/wikis/home#translating)
 - [Modeling and texturing](https://gitlab.com/xonotic/xonotic-data.pk3dir/issues?label_name=Area%3A+Assets)
 - Documentation
   - Some of it is still scattered in [Docs](https://gitlab.com/xonotic/xonotic/tree/master/Docs) instead of being on our [wiki](https://gitlab.com/xonotic/xonotic/wikis/home)
@@ -38,18 +54,3 @@ We're mainly looking for help in the following areas:
   - Please don't create anything that looks official (social media accounts, entries on pages like steam, etc.) without contacting us, we like to manage things ourselves to keep the information up to date
   - All other kinds of PR are very welcome - make videos or articles, share links, spread the word
 
-## Developing
-
-To compile the latest revision 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 [COPYING](COPYING) file for more details.