-Terms and Conditions of Use
+NetRadiant
+==========
+The open source, cross platform level editor for idtech games (NetRadiant fork)
--------
-GTKRadiant contains software developed by Id Software, Loki Software and third
-party contributors.
+Getting the Sources
+===================
-All portions of GTKRadiant which are licensed by Id Software are subject to the
-terms of its LIMITED USE SOFTWARE LICENSE AGREEMENT, a copy of which is included
-with GTKRadiant. If you did not receive a LIMITED USE SOFTWARE LICENSE
-AGREEMENT, please contact Id Software immediately at info@idsoftware.com.
+The latest source is available from the git repository:
+https://gitlab.com/xonotic/netradiant.git
-All portions of GTKRadiant which have been developed by Loki Software and/or
-third party contributors are licensed under the terms set forth below.
+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
-Copyright (c) 1999-2000, Loki Software, Inc.
-All rights reserved.
+See also https://gitlab.com/xonotic/netradiant/ for a source browser,
+issues and more.
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Dependencies
+============
-Redistributions of source code must retain the above copyright notice, this list
-of conditions and the following disclaimer.
+ * OpenGL
+ * LibXml2
+ * GTK2
+ * GtkGLExt
+ * LibJpeg
+ * LibPng
+ * ZLib
-Redistributions in binary form must reproduce the above copyright notice, this
-list of conditions and the following disclaimer in the documentation and/or
-other materials provided with the distribution.
+Compiling
+=========
-Neither the name of Loki Software nor the names of its contributors may be used
-to endorse or promote products derived from this software without specific prior
-written permission. No license is hereby granted to any trademarks, tradenames
-or logos.
+This project uses the usual CMake workflow:
-THIS SOFTWARE IS PROVIDED BY LOKI AND THE CONTRIBUTORS "AS IS." ANY AND ALL
-WARRANTUES, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRENGEMENT ARE HEREBY DISCLAIMED. IN NO EVENT SHALL LOKI OR THE
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
-OR CONSEQUENTIAL DAMAGES (INCLUDING, WITHOUT LIMITATION, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
-OF SUCH DAMAGE.
+ 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
projects / xonotic / netradiant.git / blobdiff