Remove trailing ` in README.md
[xonotic/netradiant.git] / README.md
1 NetRadiant
2 ==========
3
4 The open source, cross platform level editor for idtech games (Radiant fork)
5
6 # Getting the Sources
7
8 The latest source is available from the git repository:
9 https://gitlab.com/xonotic/netradiant.git
10
11 The git client can be obtained from the Git website:
12 http://git-scm.org
13
14 To get a copy of the source using the commandline git client:
15 ```
16 git clone https://gitlab.com/xonotic/netradiant.git
17 cd netradiant
18 ```
19
20 See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and more.
21
22 # Dependencies
23
24  * OpenGL
25  * LibXml2
26  * GTK2
27  * GtkGLExt
28  * LibJpeg
29  * LibPng
30  * ZLib
31
32 # Compiling
33
34 This project uses the usual CMake workflow:
35
36 `cmake -H. -Bbuild && cmake --build build -- -j$(nproc)`
37
38 ## linux
39
40 ```
41 cmake -H. -Bbuild -G "Unix Makefiles"
42 ```
43
44 ## msys2
45
46 `pacman -S --needed base-devel`
47
48 ### 32 bit:
49
50 ```
51 pacman -S --needed mingw-w64-i686-{toolchain,cmake,gtk2,gtkglext}
52 cmake -H. -Bbuild -G "MSYS Makefiles" -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw32/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw32/lib/gtk-2.0/include
53 ```
54
55 ### 64 bit:
56
57 ```
58 pacman -S mingw-w64-x86_64-{toolchain,cmake,gtk2,gtkglext}
59 cmake -H. -Bbuild -G "MSYS Makefiles" -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw64/lib/glib-2.0/include -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw64/lib/gtk-2.0/include
60 ```
61
62 ## OS X:
63
64 ```
65 brew install gtkglext
66 brew install Caskroom/cask/xquartz
67 brew link --force gettext
68 ```
69
70 More Compilation Details
71 ------------------------
72
73 options:
74  * `DOWNLOAD_GAMEPACKS=ON`
75    Automatically download the gamepack data during the first compilation
76  * `RADIANT_ABOUTMSG="Custom build"`
77    A message shown in the about dialog
78
79 targets:
80  * `radiant`    Compiles the radiant core binary
81  * `modules`    Compiles all modules (each module has its own target as well)
82  * `plugins`    Compiles all plugins (each plugin has its own target as well)
83  * `game_packs` Downloads the game pack data
84  * `quake3`     Compiles all the Quake3 tools
85    - `q3map2`     Quake3 map compiler
86    - `q3data`