]> git.xonotic.org Git - xonotic/xonotic.git/blobdiff - README.md
Fix macOS SDL2 framework permissions
[xonotic/xonotic.git] / README.md
index e34a4d180187d72729e42e58db5419c414dfebc5..fa6dd7430861ac6065f78a85701f2dce328882a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,51 +1,56 @@
 # 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
 
-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/).
+[Beta builds](https://gitlab.com/xonotic/xonotic/-/wikis/Autobuilds) are available at https://beta.xonotic.org/autobuild
 
-- [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)
+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.
 
-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.
+*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.*
 
-**MD5**: 1bd46c1fb79aae42bb13e74f5a0ff46e
-**Package size**: 946M
+## Community
 
-## Contributing
+The community is primarily active in the [forums](https://forums.xonotic.org/) and [chat rooms](https://gitlab.com/xonotic/xonotic/-/wikis/Chat-Rooms).
 
-We're currently looking for help in the following areas:
+## Documentation
 
-- Modeling and texturing
-  - We're looking for someone with texturing skills to paint new glowy skins for our player models
-- 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)
-  - Some [wiki](https://gitlab.com/xonotic/xonotic/wikis/home) pages are slightly out of date or contain links to empty pages
-  - Fixing typos everywhere and anywhere - attention to detail is important to make a good impression on potential players
-  - Even if you're new, just letting us know what you're struggling with helps so we can focus on improving those areas first
-- Testing
-  - If you're running a server or play off-line often, please consider using the autobuild or git versions to help us find bugs
+[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
 
-To compile the latest version 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).
+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).
 
-## 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).
+Please ensure you've read and understood [CONTRIBUTING.md](CONTRIBUTING.md) before pushing commits or opening merge requests.
 
-## Wiki
+## Contributing
 
-[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.
+We're looking for help in the following areas:
 
-## License
+- [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)
+  - Some [wiki](https://gitlab.com/xonotic/xonotic/wikis/home) pages are slightly out of date or contain links to empty pages
+  - Fixing typos everywhere and anywhere - attention to detail is important to make a good impression on potential players
+  - Even if you're new, just letting us know what you're struggling with helps so we can focus on improving those areas first
+- Testing
+  - If you're running a server or play off-line often, please consider using the [autobuild](https://gitlab.com/xonotic/xonotic/wikis/Autobuilds) or [git](https://gitlab.com/xonotic/xonotic/wikis/Repository_Access) versions to help us find bugs (when playing online, the server's version of the gamecode is downloaded and used by all clients so you have to play offline or run your own server for testing)
+- PR
+  - 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
 
-Distributed under the GPLv2 license. See the [LICENSE](LICENSE) file for more details.