[q3map2] Unwind script stack in case of script loading error.
[xonotic/netradiant.git] / COMPILING
index b3ec018..29a707c 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -1,29 +1,31 @@
-developer documentation for GtkRadiant 1.6.0 (Zeroradiant)
-==========================================================
+
+developer documentation for NetRadiant
+======================================
+
+(NOTE: outdated stuff has been ROT13ed)
 
 getting the source
 ==================
 
-The latest source is available from the Subversion repository.
-  https://zerowing.idsoftware.com/svn/radiant/GtkRadiant/trunk/
+The latest source is available from the git repository.
+  git://git.icculus.org/divverent/netradiant.git
 
-The subversion client can be obtained from the Subversion site.
-  http://subversion.tigris.org
+The git client can be obtained from the Subversion site.
+  http://git-scm.org
 
-To get a copy of the source using the commandline Subversion client:
+To get a copy of the source using the commandline git client:
   Change the current directory to the desired location for the source.
-  svn checkout https://zerowing.idsoftware.com/svn/radiant/GtkRadiant/trunk/ ./GtkRadiant
-  svn checkout https://zerowing.idsoftware.com/svn/radiant.gamepacks/Q3Pack/trunk/ ./GtkRadiant/games/Q3Pack
-  svn checkout https://zerowing.idsoftware.com/svn/radiant.gamepacks/UFOAIPack/trunk/ ./GtkRadiant/games/UFOAIPack
+  git clone git://git.icculus.org/divverent/netradiant.git
+  cd netradiant
 
 
-Linux/OSX(using X-windows)
-==========================
+
+Linux(using X-windows)
+======================
 
 environment:
 - gcc >= version 3.1 (preferably)
-- scons >= 0.96 (radiant is built with scons rather than make)
-- python >= 2.3.0, (scons requires python, some build steps use python)
+- GNU make
 - svn >= 1.1 (some build steps use svn)
 
 dependencies:
@@ -32,39 +34,62 @@ dependencies:
 - libxml2 >= 2.0.0
 - zlib >= 1.2.0 (for archivezip module)
 - libpng >= 1.2.0 (for imagepng module)
-- libmhash = 0.9.0 (for q3map2)
 
 build:
-Execute 'scons SETUP=0' in the directory containing SConscript
-
-install:
-run 'python ./GtkRadiant/install.py'
-note - this script should be run after each time you update from svn
+run 'make'
 
 run:
-Execute './GtkRadiant/install/radiant.x86' (or './GtkRadiant/install/radiant.ppc' on osx)
+Execute 'install/radiant.x86'
 
+OSX(using X-windows)
+====================
 
-Win32 (2000, XP or Vista)
+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:
-- visual studio 2005
-- python 2.3.0 or later (some build steps use python)
-- subversion 1.1 or later (some build steps use svn)
-
-dependencies are prepackaged archives, extract them to the directory above GtkRadiant.sln:
-- http://zerowing.idsoftware.com/files/radiant/developer/1.5/gtkradiant-1.5-dependencies-1.0.zip
+- 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:
-Open GtkRadiant.sln.
-In tools > options > projects > VC++ Directories > executables, add the paths to python.exe (e.g. c:\python23\) and svn.exe (e.g. c:\svn\)
-Hit 'Build > Build Solution' (F7)
-
-install:
-run 'python ./GtkRadiant/install.py'
-note - this script should be run after each time you update from svn
+- Start the MSYS shell
+- Switch to the directory with NetRadiant source
+- make MAKEFILE_CONF=mingw-Makefile.conf
 
 run:
-set Project > Properties > Debugging > Command to "$(SolutionDir)install/$(TargetFileName)"
-hit 'Debug > Start' (F5)
+- 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