]> git.xonotic.org Git - xonotic/xonotic.wiki.git/blobdiff - Compiling_In_Windows.md
include old redmine-hosted files
[xonotic/xonotic.wiki.git] / Compiling_In_Windows.md
index 6abd82df4dacc1e8764da4fb7c9f3f0a1cb4ffea..422ee44bc394a738b21393833b336979e905cc32 100644 (file)
@@ -1,11 +1,9 @@
 Compiling In Windows
 ====================
 
-{{\>toc}}
+**This guide has been replaced by a shorter alternative.** This guide should still work, and get you a standalone MinGW/MSYS environment with access to msysgit. The new method only makes use of msysgit and is therefore easier and faster to set up. See the [Repository Access](Repository_Access#windows) page.
 
-**This guide has been replaced by a shorter alternative.** This guide should still work, and get you a standalone MinGW/MSYS environment with access to msysgit. The new method only makes use of msysgit and is therefore easier and faster to set up. See the [Repository Access\#Windows](Repository Access\#Windows) page.
-
-This is an unofficial updated version of the outdated [Compiling in Windows](Outdated_Compiling_In_Windows) page. There are no more automated tools in this version of the guide.
+This is an unofficial updated version of the outdated [Compiling in Windows](Outdated_Compiling_in_Windows) page. There are no more automated tools in this version of the guide.
 
 You will need about 10 gigabytes of disk space to keep the sources (the uncompressed texture files are quite large and git keeps a backup copy, doubling the actual size of the sources).
 
@@ -13,20 +11,34 @@ Step 1: installing the prerequisites
 ------------------------------------
 
 To compile and run Xonotic in Windows, you will need to download the following. Do not install anything yet, this is covered in the next section.
-\* The latest version of [MinGW](http://sourceforge.net/projects/mingw/files/). At the time of writing this guide, mingw provides an installer (mingw-get-inst). More up-to-date information on how to get MinGW can be found on http://mingw.org
-\* [msysgit](https://code.google.com/p/msysgit/downloads/list). Make sure you get the latest **full installer for official Git** (not the self-contained packages). At the time of writing this, the latest installer is called Git-1.7.11-preview20120710.exe.
+
+-   The latest version of [MinGW](http://sourceforge.net/projects/mingw/files/). At the time of writing this guide, mingw provides an installer (mingw-get-inst). More up-to-date information on how to get MinGW can be found on http://mingw.org
+-   [msysgit](https://code.google.com/p/msysgit/downloads/list). Make sure you get the latest **full installer for official Git** (not the self-contained packages). At the time of writing this, the latest installer is called Git-1.7.11-preview20120710.exe.
 
 ### Installing MinGW
 
 These instructions apply to mingw-get-inst. Run the installer. When setting up the path, if you do not pick the default, make at least sure that the installation path you choose contains no space in it. Thus, Program Files is out of question.
 
-When you reach the "select components" section, you need to check "MSYS Basic System" (**not** "MinGW Developer Toolkit"). You will also need the C compiler, which should be selected by default.
+When you reach the “select components” section, you need to check “MSYS Basic System” (**not** “MinGW Developer Toolkit”). You will also need the C compiler, which should be selected by default.
 
-When the setup is complete, you will get a "MinGW Shell" in your start menu. This is a Unix-like shell that you will soon use to manage and compile the Xonotic source files. It will also be used to launch the game.
+When the setup is complete, you will get a “MinGW Shell” in your start menu. This is a Unix-like shell that you will soon use to manage and compile the Xonotic source files. It will also be used to launch the game.
 
 ### Installing msysgit
 
-Run the installer. At the component selection screen (screenhsot: attachment:"git-1-components.png"), uncheck the "Associate .sh files" option. Windows Explorer Integration can also optionnally be unselected - it is only useful if you plan on contributing and do not like using git purely from the command line to do so. When you get to the PATH adjusting screen (screenshot: attachment:git-2-path.png), you need to select the second option (Run Git from the Windows Command Prompt). This ensures that git can be run from the MinGW shell, as we will not use the shell that comes with msysgit for this. Finally, in the line ending screen (screenshot: attachment:git-3-crlf.png), keep the first option selected unless you know what you're doing.
+Run the installer.
+At the component selection screen (screenshot), uncheck the “Associate .sh files” option.  
+
+![](assets/images/git-1-components.png)
+
+Windows Explorer Integration can also optionnally be unselected — it is only useful if you plan on contributing and do not like using git purely from the command line to do so.
+When you get to the PATH adjusting screen (screenshot), you need to select the second option (Run Git from the Windows Command Prompt).  
+
+![](assets/images/git-2-path.png)
+
+This ensures that git can be run from the MinGW shell, as we will not use the shell that comes with msysgit for this.
+Finally, in the line ending screen (screenshot), keep the first option selected unless you know what you’re doing.  
+
+![](assets/images/git-3-crlf.png)
 
 ### Installing the dependencies in MinGW
 
@@ -40,24 +52,24 @@ To close a MinGW Shell, just type
 
     exit
 
-But keep this one open, we're going to use it some more.
+But keep this one open, were going to use it some more.
 
 To close a MinGW Shell, just type
 
     exit
 
-But keep this one open, we're going to use it some more.
+But keep this one open, were going to use it some more.
 
 Step 2: downloading the Xonotic source files
 --------------------------------------------
 
-In this step, we will clone the Xonotic git repositories inside MinGW's install directory.
+In this step, we will clone the Xonotic git repositories inside MinGWs install directory.
 
 In your MinGW Shell, type
 
     git clone git://git.xonotic.org/xonotic/xonotic.git
 
-This will clone the base repository, which contains a script called "`all`" that will manage the subrepositories. I will call this script `./all` to avoid confusion, as this is how we will be using it in the terminal.
+This will clone the base repository, which contains a script called “`all`” that will manage the subrepositories. I will call this script `./all` to avoid confusion, as this is how we will be using it in the terminal.
 
 Next, type
 
@@ -75,7 +87,7 @@ Compiling the game is quite simple. In your MinGW Shell, just type
 
 This will compile fteqcc (which is a compiler for the QuakeC language), then the game code using fteqcc, then the DarkPlaces engine.
 
-This step can take a few minutes, so be patient! When it's over, check the last few lines to see if it reports any errors.
+This step can take a few minutes, so be patient! When its over, check the last few lines to see if it reports any errors.
 
 Step 4: running the game!
 -------------------------
@@ -117,3 +129,4 @@ Getting help
 ------------
 
 You can always ask for help in the [Xonotic forums](http://forums.xonotic.org), under the Help and Support section.
+