CMake: Make dll bundling optional
[xonotic/netradiant.git] / COMPILING
index 8474e4232cb377471c70654fe718942c5a404de2..29a707c5917ef3dbdc40fce5dfbb2bbc92cc425e 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -1,24 +1,22 @@
-developer documentation for GtkRadiant 1.5.0-div0
-=================================================
+
+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 http://emptyset.endoftheinternet.org/svn/radiant15/trunk/ ./GtkRadiant
-  svn checkout -r29 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
-  For other game packs, see https://zerowing.idsoftware.com/svn/radiant.gamepacks/
-  Note that they must be in GtkRadiant 1.5's format (like the ones in a branches/1.5 subfolder)!
+  git clone git://git.icculus.org/divverent/netradiant.git
+  cd netradiant
 
 
 
@@ -41,22 +39,31 @@ build:
 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
-- Xcode developer tools installed
+- OS X 10.5 or 10.6
+- Xcode developer tools installed (OSX DVD)
 - X11 (from the OS X DVD)
-- fink installed
-- the following fink packages installed:
-  gtkglext1 pkgconfig glib2-dev libxml2 gtk+2-dev pango1-xft2-dev atk-dev atk1 gettext-dev
+- 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
 
@@ -64,23 +71,25 @@ Win32 (2000, XP, Vista or Windows 7)
 ==================
 
 environment:
-- MinGW
-  http://www.mingw.org/wiki/HOWTO_Install_the_MinGW_GCC_Compiler_Suite (the installer link)
-  Install this to c:\mingw
-- MSYS
-  http://www.mingw.org/wiki/msys (you need the installer MSYS-versionnumber.exe)
-  Install this to c:\msys\1.0
+- 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/radiant-deps-mingw32.zip
-  Preferably extract this one to c:\mingw\radiant-deps-mingw32
+  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 (to be found in c:\msys\1.0\msys.bat)
+- Start the MSYS shell
 - 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
+- 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