doc fixes

[xonotic/netradiant.git] / COMPILING

diff --git a/COMPILING b/COMPILING
index 7dd7bd14d7c7f5fe343bcfa7aabf0117f64aaf72..4b57fbbd2335609c8cb23b3cfa9c1526d37aa787 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -1,30 +1,31 @@
-developer documentation for GtkRadiant 1.5.0
-============================================
+
+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/branches/1.5/ ./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/branches/1.5/ ./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:
@@ -33,40 +34,55 @@ 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)
+====================
+
+environment:
+- OS X 10.5 or 10.6
+- Xcode developer tools installed (OSX DVD)
+- X11 (from the OS X DVD)
+- MacPorts or fink 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
 
+build:
+run 'make'
 
+run:
+Switch into the install folder, and run NetRadiant.app
 
-Win32 (2000, XP or Vista)
+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/HOWTO_Install_the_MinGW_GCC_Compiler_Suite (the installer link)
+  Install this to c:\mingw, and select the components C compiler, C++ compiler, Make
+- MSYS
+  http://www.mingw.org/wiki/msys (you need the installer MSYS-versionnumber.exe)
+  Install this to c:\msys\1.0
+- Prepackaged Radiant dependencies (Gtk and other stuff):
+  http://www.icculus.org/netradiant/files/radiant-deps-mingw32.zip
+  Preferably extract this one to c:\mingw\radiant-deps-mingw32
+- Subversion must be installed and available in PATH to download the game packs
 
 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 (to be found in c:\msys\1.0\msys.bat)
+- Switch to the directory with NetRadiant source
+- cp mingw-Makefile.conf Makefile.conf
+- (edit mingw-Makefile.conf in case you installed anything to other locations
+  than the recommended ones)
+- make
 
 run:
-set Project > Properties > Debugging > Command to "$(SolutionDir)install/$(TargetFileName)"
-hit 'Debug > Start' (F5)
+- in the "install" directory, double click netradiant.exe