Merge branch 'gamepackdeps' into 'master'

[xonotic/netradiant.git] / COMPILING

diff --git a/COMPILING b/COMPILING
index 3aecea5838372ff69ac0966487fb3edc5de3305f..29a707c5917ef3dbdc40fce5dfbb2bbc92cc425e 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -1 +1,95 @@
-see docs/developer/README
+
+developer documentation for NetRadiant
+======================================
+
+(NOTE: outdated stuff has been ROT13ed)
+
+getting the source
+==================
+
+The latest source is available from the git repository.
+  git://git.icculus.org/divverent/netradiant.git
+
+The git client can be obtained from the Subversion site.
+  http://git-scm.org
+
+To get a copy of the source using the commandline git client:
+  Change the current directory to the desired location for the source.
+  git clone git://git.icculus.org/divverent/netradiant.git
+  cd netradiant
+
+
+
+Linux(using X-windows)
+======================
+
+environment:
+- gcc >= version 3.1 (preferably)
+- GNU make
+- svn >= 1.1 (some build steps use svn)
+
+dependencies:
+- gtk+ >= 2.4.0 (requires glib, atk, pango, iconv, etc)
+- gtkglext >= 1.0.0 (requires opengl)
+- libxml2 >= 2.0.0
+- zlib >= 1.2.0 (for archivezip module)
+- libpng >= 1.2.0 (for imagepng module)
+
+build:
+run 'make'
+
+run:
+Execute 'install/radiant.x86'
+
+OSX(using X-windows)
+====================
+
+environment:
+- OS X 10.5 or 10.6
+- Xcode developer tools installed (OSX DVD)
+- X11 (from the OS X DVD)
+- MacPorts or fink or homebrew installed
+- the following packages installed:
+  Macports:
+    gtkglext pkgconfig glib2-devel libxml2 gtk2 pango atk gettext wget
+  Fink:
+    gtkglext1 pkgconfig glib2-dev libxml2 gtk+2 gtk+2-dev pango1-xft2-ft219-dev atk1 gettext-dev wget
+  homebrew:
+    gtk+ gtkglext
+
+build:
+run 'make'
+
+homebrew build:
+run 'export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/opt/X11/lib/pkgconfig
+make'
+
+run:
+Switch into the install folder, and run NetRadiant.app
+
+Win32 (2000, XP, Vista or Windows 7)
+==================
+
+environment:
+- MinGW (http://www.mingw.org/wiki/Getting_Started)
+  Install this to c:\mingw, and select the components C compiler, C++ compiler
+  and MSYS Basic System
+- Start the MSYS shell once, then exit it
+- Prepackaged Radiant dependencies (Gtk and other stuff):
+  http://www.icculus.org/netradiant/files/netradiant-dependencies-mingw32-20101211-7z.exe
+  Extract this one to
+  c:\mingw\msys\1.0\home\username
+  (if you do this with 7zip, keep the "netradiant-dependencies-mingw32" folder
+  name of the contents)
+- now download the source from the MSYS shell, if you don't already have it:
+  ~/netradiant-dependencies-mingw32/util/bin/git clone git://git.icculus.org/divverent/netradiant.git
+
+build:
+- Start the MSYS shell
+- Switch to the directory with NetRadiant source
+- make MAKEFILE_CONF=mingw-Makefile.conf
+
+run:
+- in the "install" directory, double click netradiant.exe
+- if you get a DLL not found error, copy the DLL from either c:\mingw\bin or
+  from c:\mingw\msys\1.0\bin to the "install" directory