]> git.xonotic.org Git - xonotic/netradiant.git/blobdiff - README
target_link_libraries
[xonotic/netradiant.git] / README
diff --git a/README b/README
index c0370749848faef9c976ae9a6d7158eaf7185cb9..be5a92f1b8f20f3e81051185de3c3faed28fa054 100644 (file)
--- a/README
+++ b/README
@@ -1,49 +1,61 @@
-Terms and Conditions of Use\r
-\r
-\r
--------\r
-\r
-GTKRadiant contains software developed by Id Software, Loki Software and third \r
-party contributors.\r
-\r
-All portions of GTKRadiant which are licensed by Id Software are subject to the \r
-terms of its LIMITED USE SOFTWARE LICENSE AGREEMENT, a copy of which is included \r
-with GTKRadiant. If you did not receive a LIMITED USE SOFTWARE LICENSE \r
-AGREEMENT, please contact Id Software immediately at info@idsoftware.com.\r
-\r
-All portions of GTKRadiant which have been developed by Loki Software and/or \r
-third party contributors are licensed under the terms set forth below.\r
-\r
--------\r
-\r
-Copyright (c) 1999-2000, Loki Software, Inc. \r
-All rights reserved.\r
-\r
-Redistribution and use in source and binary forms, with or without modification, \r
-are permitted provided that the following conditions are met:\r
-\r
-Redistributions of source code must retain the above copyright notice, this list \r
-of conditions and the following disclaimer.\r
-\r
-Redistributions in binary form must reproduce the above copyright notice, this \r
-list of conditions and the following disclaimer in the documentation and/or \r
-other materials provided with the distribution.\r
-\r
-Neither the name of Loki Software nor the names of its contributors may be used \r
-to endorse or promote products derived from this software without specific prior \r
-written permission. No license is hereby granted to any trademarks, tradenames \r
-or logos.\r
-\r
-THIS SOFTWARE IS PROVIDED BY LOKI AND THE CONTRIBUTORS "AS IS." ANY AND ALL \r
-WARRANTUES, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED \r
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND \r
-NONINFRENGEMENT ARE HEREBY DISCLAIMED. IN NO EVENT SHALL LOKI OR THE \r
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, \r
-OR CONSEQUENTIAL DAMAGES (INCLUDING, WITHOUT LIMITATION, PROCUREMENT OF \r
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING \r
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY \r
-OF SUCH DAMAGE.\r
-\r
--------\r
+NetRadiant
+==========
+
+The open source, cross platform level editor for idtech games (NetRadiant fork)
+
+
+Getting the Sources
+===================
+
+The latest source is available from the git repository:
+https://gitlab.com/xonotic/netradiant.git
+
+The git client can be obtained from the Git website:
+http://git-scm.org
+
+To get a copy of the source using the commandline git client:
+  git clone https://gitlab.com/xonotic/netradiant.git
+  cd netradiant
+
+See also https://gitlab.com/xonotic/netradiant/ for a source browser,
+issues and more.
+
+Dependencies
+============
+
+ * OpenGL
+ * LibXml2
+ * GTK2
+ * GtkGLExt
+ * LibJpeg
+ * LibPng
+ * ZLib
+
+Compiling
+=========
+
+This project uses the usual CMake workflow:
+
+  mkdir build && cd build && cmake .. && make
+
+More Compilation Details
+------------------------
+
+CMake options:
+ * DOWNLOAD_GAMEPACKS=ON
+   Automatically download the gamepack data during the first compilation
+ * RADIANT_ABOUTMSG="Custom build"
+   A message shown in the about dialog
+
+Make targets:
+ * radiant    Compiles the radiant core binary
+ * plugins    Compiles all plugins (each plugin has its own target as well)
+ * modules    Compiles all modules (each module has its own target as well)
+ * game_packs Downloads the game pack data
+ * quake3     Compiles all the Quake3 tools
+  * q3map2    Quake3 map compiler
+  * q3data
+ * quake2     Compiles all the Quake2 tools (Note: needs to be compiled explicitly)
+  * q2map     Quake2 map compiler
+  * q2data
+  * h2data