Add descriptions to most weapons

[xonotic/xonotic.wiki.git] / Repository_Access.md

diff --git a/Repository_Access.md b/Repository_Access.md
index cec3f8add8a15de7962de4fea142aa5c97674953..84c57603972125e8e6512364661d7b69c796fb84 100644 (file)
--- a/Repository_Access.md
+++ b/Repository_Access.md
@@ -24,7 +24,9 @@ Note: `libasound2-dev libxext-dev libxxf86vm-dev p7zip-full unzip wget x11proto-
 
 **Fedora** and other **RPM based** distro dependencies:
 
-    autoconf automake gcc-c++ gmp-devel libalsa2-static-devel libjpeg62-devel libjpeg-turbo-devel libjpeg62-static-devel libtool SDL2-devel x11-proto-devel
+    autoconf automake gcc-c++ gmp-devel libjpeg-turbo-devel libtool SDL2-devel
+
+Note: `x11-proto-devel` or `xorg-x11-proto-devel` might be needed but might be already installed.
 
 **Archlinux** dependencies:
 
@@ -42,7 +44,7 @@ It is recommended that you make a shortcut to MSYS2 MINGW64 shell (simply right
 
 You can now use this shell to continue on with the guide and clone the Xonotic repositories.
 
-### MacOS
+### macOS
 
 You must first install **XCode** which comes on your installation DVD or can be downloaded from the Apple website. This package provides tools like **Git and GCC**, which are needed for successful checkout and compilation of Xonotic. Some versions of XCode come with Git and others don’t - if you don’t have Git after installing XCode get it here: [XCode installer](http://sourceforge.net/projects/git-osx-installer/files/)
 
@@ -59,10 +61,6 @@ To begin downloading:
 
 The **git://** protocol uses port **9418**, which may be a problem if you’re behind a **strict firewall**. You may instead use the clone url http://git.xonotic.org/xonotic/xonotic.git (however, using the git protocol directly is preferred for performance reasons).
 
-For Windows users: once finished cloning move to the main repository (`cd xonotic`) and checkout the branch Mario/Win64 with the command:
-
-    git checkout -b Mario/win64 origin/Mario/win64
-
 Now the game can be compiled and run with the following commands:
 
     ./all compile -r
@@ -70,9 +68,9 @@ Now the game can be compiled and run with the following commands:
 
 **Note:** if you encounter en error similar to darkplaces#111, try `./all clean && ./all compile -r -0`.
 
-You can use just `./all compile` to create a slower build with debug symbols but usually you want `-r`.
+You can use just `./all compile -d` to create a slower unoptimized (debug) build with debug symbols but usually you want `-r` (which is also the new default if you have recent enough git).
 
-The `./all run` or `./all compile` line can be followed by one of `glx` (Linux native), `sdl` (input/sound managed by SDL), `agl` (macOS native), `wgl` (Windows native), or `dedicated` (for server hosting) to choose which executable to run or compile. E.g. `./all compile -r dedicated`.
+The `./all run` or `./all compile` line can be followed by `dedicated` to build or run the executable for server hosting. E.g. `./all compile -r dedicated`.
 
 The `run` command can also be followed by standard DarkPlaces commandline arguments:
 
@@ -85,8 +83,6 @@ To update your Git clone:
     ./all update  # pull and prune
     ./all compile -r  # recompile what changed
 
-**Note:** The compiled binary will have a faint watermark with the git revision. To remove it completely put `set menu_watermark ""` into your `autoexec.cfg`.
-
 **Note:** If you intend to play on public servers, you should probably also enable the nexcompat repo to download additional textures that are used on some older unofficial maps. Use `touch data/xonotic-nexcompat.pk3dir.yes` and `./all update`. For mappers: these textures should NOT be used on new maps.
 
 ***
@@ -98,13 +94,15 @@ If you run into issues with the latest version you can easily revert to an older
 Contributing and getting write access
 -------------------------------------
 
+Cloning (one of) our repos and submitting MRs from there (as in any other project) works but you won't be able to use our CI setup for the data repo (which seems to need a custom runner). It's therefore a good idea to join the Xonotic group and get push access - then you can create branches in our repos and use our CI.
+
 A condition for write (push) access is that you agree that any code or data you push will be licensed under the General Public License, version 2, with or without the “or any later version” clause. In case the directory the changes apply to contains a LICENSE or COPYING file indicating another license, then your pushed code has to be dual licensed appropriately. Subdirectories currently having a dual license:
 \* data/qcsrc/warpzonelib - dual licensed as “GPLv2 or later” or MIT license.
 In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
 
 To apply for write access, add your SSH key to your GitLab account and ask for access in #xonotic on the FreeNode IRC network or [request access](https://docs.gitlab.com/ce/user/group/index.html#request-access-to-a-group) using the GitLab interface.
 
-### Windows/Linux/OS X
+### Windows/Linux/macOS
 
 Get a checkout (see above), and do:
 
@@ -133,7 +131,7 @@ Lists all the branches known for all the respective repositories.
 
     ./all compile
 
-Compiles the game, assuming that you have the required libs installed. Don't forget `-r` if you wanna actually play the game with decent fps.
+Compiles the game, assuming that you have the required libs installed.
 
     ./all checkout BRANCH
 
@@ -143,11 +141,11 @@ Switch to that branch in all repositories where its available.
 
 This command commits and pushes your local changes.
 
-    ./all run xonotic
+    ./all run
 
 Starts the Xonotic client
 
-    ./all run dedicated xonotic
+    ./all run dedicated
 
 Starts a Xonotic dedicated server