* add compiling file from 1.5 with minor changes

[xonotic/netradiant.git] / COMPILING

diff --git a/COMPILING b/COMPILING
index a848ff8f3477e3fff9d6809e54bd2accb743d635..b3ec018249e03ef0b02f3c523284956b70da28cc 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -1,7 +1,70 @@
- * understand relative paths in the .game file
- * ignore warnings: 4996 4244 4267
- ( some CRT API warning stuff, and size conversion warnings)
- * using the same updated Gtk win32 as GtkR 1.5 (may be packaged a bit differently for sanity)
- * converted the project files to VC8
- * disabled all the modules that are not necessary for Q3 editing
- * default parameters can't be used in function typedefs anymore, removed those and fixed the code accordingly
+developer documentation for GtkRadiant 1.6.0 (Zeroradiant)
+==========================================================
+
+getting the source
+==================
+
+The latest source is available from the Subversion repository.
+  https://zerowing.idsoftware.com/svn/radiant/GtkRadiant/trunk/
+
+The subversion client can be obtained from the Subversion site.
+  http://subversion.tigris.org
+
+To get a copy of the source using the commandline Subversion 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
+
+
+Linux/OSX(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)
+- 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)
+- 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:
+Execute './GtkRadiant/install/radiant.x86' (or './GtkRadiant/install/radiant.ppc' on osx)
+
+
+Win32 (2000, XP or Vista)
+==================
+
+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
+
+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
+
+run:
+set Project > Properties > Debugging > Command to "$(SolutionDir)install/$(TargetFileName)"
+hit 'Debug > Start' (F5)