summaryrefslogtreecommitdiff
path: root/doc/README.txt
diff options
context:
space:
mode:
authorPerttu Ahola <celeron55@gmail.com>2011-11-03 21:36:42 +0200
committerPerttu Ahola <celeron55@gmail.com>2011-11-03 21:36:42 +0200
commit1469196d3b6d1b4a5ba4842d04f19c33444f6bcd (patch)
treed04d9844257958a73663d5495f04ddb49de8c934 /doc/README.txt
parente9fd3def90e59abc7e242e58b5202ac45783ee5c (diff)
downloadminetest-1469196d3b6d1b4a5ba4842d04f19c33444f6bcd.tar.gz
minetest-1469196d3b6d1b4a5ba4842d04f19c33444f6bcd.tar.bz2
minetest-1469196d3b6d1b4a5ba4842d04f19c33444f6bcd.zip
Update /README.txt, remove duplicate /doc/README.txt and update CMakeLists.txt to package /README.txt
Diffstat (limited to 'doc/README.txt')
-rw-r--r--doc/README.txt254
1 files changed, 0 insertions, 254 deletions
diff --git a/doc/README.txt b/doc/README.txt
deleted file mode 100644
index 6ae236556..000000000
--- a/doc/README.txt
+++ /dev/null
@@ -1,254 +0,0 @@
-Minetest-c55
----------------
-An InfiniMiner/Minecraft inspired game.
-Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
-
-Further documentation:
-----------------------
-- Website: http://celeron.55.lt/~celeron55/minetest/
-- Wiki: http://celeron.55.lt/~celeron55/minetest/wiki/
-- Forum: http://celeron.55.lt/~celeron55/minetest/forum/
-
-This is a development version:
-------------------------------
-- Don't expect it to work as well as a finished game will.
-- Please report any bugs to me. That way I can fix them to the next release.
- - debug.txt is useful when the game crashes.
-
-Controls:
----------
-- See the in-game pause menu
-- Settable in the configuration file, see the section below.
-
-Map directory:
---------------
-- Map is stored in a directory, which can be removed to generate a new map.
-- There is a command-line option for it: --map-dir
-- For a RUN_IN_PLACE build, it is located in:
- ../map
-- Otherwise something like this:
- Windows: C:\Documents and Settings\user\Application Data\minetest\map
- Linux: ~/.minetest/map
- OS X: ~/Library/Application Support/minetest/map
-
-Configuration file:
--------------------
-- An optional configuration file can be used. See minetest.conf.example.
-- Path to file can be passed as a parameter to the executable:
- --config <path-to-file>
-- Defaults:
- - If built with -DRUN_IN_PLACE=1:
- ../minetest.conf
- ../../minetest.conf
- - Otherwise something like this:
- Windows: C:\Documents and Settings\user\Application Data\minetest\minetest.conf
- Linux: ~/.minetest/minetest.conf
- OS X: ~/Library/Application Support/minetest.conf
-
-Command-line options:
----------------------
-- Use --help
-
-Compiling on GNU/Linux:
------------------------
-
-Install dependencies. Here's an example for Debian/Ubuntu:
-$ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev
-
-Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
-$ wget https://github.com/celeron55/minetest/tarball/master -O master.tar.gz
-$ tar xf master.tar.gz
-$ cd celeron55-minetest-286edd4 (or similar)
-
-Build a version that runs directly from the source directory:
-$ cmake . -DRUN_IN_PLACE=1
-$ make -j2
-
-Run it:
-$ cd bin
-$ ./minetest
-
-- Use cmake . -LH to see all CMake options and their current state
-- If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
-- You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
-- You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
- - Note that the Debug build is considerably slower
-
-Compiling on Windows:
----------------------
-
-- You need:
- * CMake:
- http://www.cmake.org/cmake/resources/software.html
- * MinGW or Visual Studio
- http://www.mingw.org/
- http://msdn.microsoft.com/en-us/vstudio/default
- * Irrlicht SDK 1.7:
- http://irrlicht.sourceforge.net/downloads.html
- * Zlib headers (zlib125.zip)
- http://www.winimage.com/zLibDll/index.html
- * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
- http://www.winimage.com/zLibDll/index.html
- * And, of course, Minetest-c55:
- http://celeron.55.lt/~celeron55/minetest/download
-- Steps:
- - Select a directory called DIR hereafter in which you will operate.
- - Make sure you have CMake and a compiler installed.
- - Download all the other stuff to DIR and extract them into there. All those
- packages contain a nice base directory in them, which should end up being
- the direct subdirectories of DIR.
- - You will end up with a directory structure like this (+=dir, -=file):
- -----------------
- + DIR
- - zlib-1.2.5.tar.gz
- - zlib125dll.zip
- - irrlicht-1.7.1.zip
- - 110214175330.zip (or whatever, this is the minetest source)
- + zlib-1.2.5
- - zlib.h
- + win32
- ...
- + zlib125dll
- - readme.txt
- + dll32
- ...
- + irrlicht-1.7.1
- + lib
- + include
- ...
- + minetest
- + src
- + doc
- - CMakeLists.txt
- ...
- -----------------
- - Start up the CMake GUI
- - Select "Browse Source..." and select DIR/minetest
- - Now, if using MSVC:
- - Select "Browse Build..." and select DIR/minetest-build
- - Else if using MinGW:
- - Select "Browse Build..." and select DIR/minetest
- - Select "Configure"
- - Select your compiler
- - It will warn about missing stuff, ignore that at this point. (later don't)
- - Make sure the configuration is as follows
- (note that the versions may differ for you):
- -----------------
- BUILD_CLIENT [X]
- BUILD_SERVER [ ]
- CMAKE_BUILD_TYPE Release
- CMAKE_INSTALL_PREFIX DIR/minetest-install
- IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
- RUN_IN_PLACE [X]
- WARN_ALL [ ]
- ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
- ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
- ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
- -----------------
- - Hit "Configure"
- - Hit "Generate"
- If using MSVC:
- - Open the generated minetest.sln
- - The project defaults to the "Debug" configuration. Make very sure to
- select "Release", unless you want to debug some stuff (it's slower)
- - Build the ALL_BUILD project
- - Build the INSTALL project
- - You should now have a working game with the executable in
- DIR/minetest-install/bin/minetest.exe
- - Additionally you may create a zip package by building the PACKAGE
- project.
- If using MinGW:
- - Using the command line, browse to the build directory and run 'make'
- (or mingw32-make or whatever it happens to be)
- - You should now have a working game with the executable in
- DIR/minetest/bin/minetest.exe
-
-Windows releases of minetest are built using a bat script like this:
---------------------------------------------------------------------
-
-set installpath="C:\tmp\minetest_install"
-set irrlichtpath="C:\tmp\irrlicht-1.7.2"
-
-set sourcedir=%CD%
-set builddir=%sourcedir%\bvc10
-mkdir %builddir%
-pushd %builddir%
-cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
-"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
-"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
-"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
-popd
-
-License of Minetest-c55
------------------------
-
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Irrlicht
----------------
-
-This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
-
- The Irrlicht Engine License
-
-Copyright © 2002-2005 Nikolaus Gebhardt
-
-This software is provided 'as-is', without any express or implied
-warranty. In no event will the authors be held liable for any damages
-arising from the use of this software.
-
-Permission is granted to anyone to use this software for any purpose,
-including commercial applications, and to alter it and redistribute
-it freely, subject to the following restrictions:
-
- 1. The origin of this software must not be misrepresented; you
- must not claim that you wrote the original software. If you use
- this software in a product, an acknowledgment in the product
- documentation would be appreciated but is not required.
- 2. Altered source versions must be plainly marked as such, and must
- not be misrepresented as being the original software.
- 3. This notice may not be removed or altered from any source
- distribution.
-
-
-JThread
----------------
-
-This program uses the JThread library. License for JThread follows:
-
-Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the "Software"),
-to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-IN THE SOFTWARE.
-
-