Update and rename README to README.md

[dragonblocks-bedrock.git] / README

diff --git a/README b/README
deleted file mode 100644 (file)
index 80c3ad0..0000000
--- a/README
+++ /dev/null
@@ -1,65 +0,0 @@
-DRAGONBLOCKS BEDROCK EDITION
-Written in C++
-An Open Source Project by Elias Fleckenstein
-
-1. General
-       1.1. What this is about
-               Dragonblocks originaly was a Browsergame I made that should be some kind of 2D Minetest (Minetest (www.minetest.net) is a game similar to 
-               Minecraft, except Minetest is free & open source and is meant to be modded). The JavaScript Edition is hosted at www.dragonblocks.tk and 
-               further developed then this C++ Version, through the C++ Version has advantages like map saving and lot larger map. I decided to call the 
-               C++ Version "Bedrock Edition" as a joke for the Minecraft C++ Version is Called Bedrock or Pocket Edition.
-       1.2. Version
-               This is the Dragonblocks Bedrock Edition 3.1.
-       1.4. Bugs
-               Please Report Bugs to eliasfleckenstein@web.de.
-       1.5. License
-               Copyright 2020 Elias Fleckenstein <eliasfleckenstein@web.de>
-               
-               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 3 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.
-
-2. Starting the Game
-       2.1. Platform Compability
-               This Game was developed on linux, therefore following instructions are only for linux users, basically because I have no idea how to
-               port the game to other platforms. Feel free to add building instructions for other systems over github.
-       2.3. Download
-               You can download the game using git:
-                       $ git clone https://github.com/EliasFleckenstein03/dragonblocks.git
-       2.2. Dependencies:
-               You need Freeglut, OpenGl, Cmake, Liblua and Libpng.
-               If you are on Debian/Ubuntu You can install them over apt: 
-                       $ sudo apt install liblua5.3-dev freeglut3-dev libgl1-mesa-dev cmake libpng-dev
-    2.3. Building
-        to Build dragonblocks run:
-            $ cd dragonblocks
-            $ cmake .
-            $ make
-       2.4. Exectute
-               2.4.1. Run-In-Place
-                       Invoke dragonblocks by typing:
-                               $ cd dragonblocks
-                               $ bin/dragonblocks --worldname <your_worldname>
-                       To see a list of worlds do:
-                               $ bin/dragonblocks --worldlist
-                       You can select a world from this list or create a new one.
-                       For more info run:
-                               $ bin/dragonblocks --help
-               2.4.2. Installation
-                       You can install dragonblocks by doing:
-                               $ sudo ./install.sh
-                       It will copy the dragonblocks directory to /usr/share/dragonblocks and place a script in
-                       /usr/bin/dragonblocks that starts dragonblocks.
-3. Developing
-    Please Refer to the Dragonblocks Wiki on Github