Renamed and added Readme

Renamed and added Readme

Author: davemoore22

README.md

@@ -1 +1,18 @@
-libtcod-first-person
+**Libtcod-Painter's Algorithm**
+
+*A libtcod example of the Painters Algorithm written in C++ and released under the MIT License*
+
+The purpose of this code snippet to display a dungeon from a first person perspective using the so-called Painter's Algorithm using the libtcod (<https://github.com/libtcod/libtcod/>) truecolour console most often used for Roguelike development. This technique was often used by old school blobber/dungeon crawlers to fake a "2.5D" view and to avoid using any 3D graphical techniques.
+
+The algorithm is quick and dirty and based upon the one used in the game Heroine Dusk (<http://heroinedusk.com>) by Clint Bellinger. Artwork/tiles used are by Clint Bellinger and are available here (<https://opengameart.org/content/first-person-dungeon-crawl-art-pack>). The codebase used for this demo is based upon the libtcod C++ tutorial here: <http://www.roguebasin.com/index.php?title=Complete_roguelike_tutorial_using_C%2B%2B_and_libtcod_-_part_4:_field_of_view>.
+
+Apologies for the hideous code. It works, and should give you an idea of how to do this sort of stuff. Future enhancements include optimising it and converting it over to C++17.
+
+Included is a Codeblocks project usable under Ubuntu Linux. It uses libtcod 1.11.1 (but I think it works as far back as libtcod 1.6).
+
+To compile in other editors/IDEs include the libtcod libraries.
+
+Comments and criticisms and more info e-mail me at davemoore22@gmail.com
+
+![Unoptimised Example](https://media.giphy.com/media/dYd8W2i9UWASg53L6r/giphy.gif)
+

bin/Debug/libtodsampleproject

@@ -1,3 +1,18 @@
+// Copyright 2019 Dave Moore
+//
+// 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.
+
 class Actor {
 public :
     int x,y; // position on map

inc/actor.hpp

@@ -1,3 +1,18 @@
+// Copyright 2019 Dave Moore
+//
+// 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.
+
 class Engine {
 public :
     TCODList<Actor *> actors;

inc/engine.hpp

@@ -1,3 +1,18 @@
+// Copyright 2019 Dave Moore
+//
+// 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.
+
 struct Tile {
     bool explored; // has the player already seen this tile ?
     Tile() : explored(false) {}

inc/map.hpp

@@ -2,7 +2,7 @@
 <CodeBlocks_project_file>
 	<FileVersion major="1" minor="6" />
 	<Project>
-		<Option title="libtod-firstperson" />
+		<Option title="libtod-paintersalgorithm" />
 		<Option pch_mode="2" />
 		<Option compiler="gcc" />
 		<Build>