From bec528c4b54d63faace18a35ee30bf2c17d56217 Mon Sep 17 00:00:00 2001
From: Gawaboumga <yourihubaut@hotmail.com>
Date: Sat, 20 Jul 2019 10:12:23 +0200
Subject: [PATCH] Add special files at root

---
 AUTHORS    |  5 +++++
 INSTALL.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 THANKS.md  | 26 ++++++++++++++++++++++++++
 3 files changed, 84 insertions(+)
 create mode 100644 AUTHORS
 create mode 100644 INSTALL.md
 create mode 100644 THANKS.md

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 000000000..24e079909
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,5 @@
+Nazara Engine was originally created in early 2012.
+It follows a complete overhaul of a previous project in order to offer more features and modularity.
+
+Jérôme "Lynix" Leclercq - main developper (lynix680@gmail.com)
+Full Cycle Games - sponsor and contributor since January 2017.
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 000000000..05c162982
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,53 @@
+# Installation
+
+> **Notice**: For french speakers, a more detailed explanation of the instructions is provided here: [Instructions pour compiler](wiki/(FR)-Compiler-le-moteur).
+
+The first step to using the engine is to recover it. This can currently be done in two ways:
+1) This can be don either from the original github (only the development is continuously evolving):
+```git clone https://github.com/DigitalPulseSoftware/NazaraEngine.git```
+2) Or by downloading a [zip file](https://github.com/DigitalPulseSoftware/NazaraEngine/archive/master.zip) containing the entire source code of the engine.
+
+All you have to do is go to the "build/" folder. The compilation system uses [premake](https://premake.github.io/) to generate build systems.
+
+## Windows 
+For Windows users, they can directly use ".bat" files such as: "Build_VS2017.bat". It will generate a solution "NazaraEngine.sln" ready to use that you can directly build to produce the libs or execute the samples.
+
+## Linux
+
+Linux users, can type: "./premake5-linux64 gmake" or with the additional argument "--cc=clang" to configure the C++ compiler used. 
+
+Some additional libraries will be required for compilation depending on the modules used:
+
+#### Audio module (OpenAL and libsndfile)
+
+-   with apt:  `sudo apt-get install libopenal-dev libsndfile1-dev`
+-   with pacman:  `sudo pacman -S openal libsndfile`
+
+#### Platform module (Freetype):
+
+-   with apt:  `sudo apt-get install libfreetype6-dev`
+-   with pacman:  `sudo pacman -S freetype2`
+
+#### Utility module (XCB + X11):
+
+-   with apt:  `sudo apt-get install libxcb-cursor-dev libxcb-ewmh-dev libxcb-randr0-dev libxcb-icccm4-dev libxcb-keysyms1-dev libx11-dev`
+-   with pacman:  `sudo pacman -S libxcb libx11`
+
+#### OpenGL renderer module:
+
+-   with apt:  `sudo apt-get install mesa-common-dev libgl1-mesa-dev`
+-   with pacman:  `sudo pacman -S mesa`
+
+#### Plugin Assimp:
+
+-   with apt:  `sudo apt-get install libassimp-dev`
+-   with pacman:  `sudo pacman -S assimp`
+
+#### The one line command to install everything is:
+
+-   with apt:  `sudo apt-get install libopenal-dev libsndfile1-dev libfreetype6-dev libxcb-cursor-dev libxcb-ewmh-dev libxcb-randr0-dev libxcb-icccm4-dev libxcb-keysyms1-dev libx11-dev mesa-common-dev libgl1-mesa-dev libassimp-dev`
+-   with pacman:  `sudo pacman -S openal libsndfile freetype2 libxcb libx11 mesa assimp`
+
+## Test
+
+One should now be able to execute the samples provided in the folder "NazaraEngine/examples/bin/" or the unit tests within "NazaraEngine/tests/".
\ No newline at end of file
diff --git a/THANKS.md b/THANKS.md
new file mode 100644
index 000000000..b2821222e
--- /dev/null
+++ b/THANKS.md
@@ -0,0 +1,26 @@
+# Thanks
+
+A special thank you to all those who may have contributed directly or indirectly to this project. We can mention:
+
+- **RafBill** and **Raakz:** Finding bugs and/or testing.
+- **Fissal "DrFisher" Hannoun**: Helping a lot in architecture design.
+- **Alexandre "Danman" Janniaux**: Helping making the POSIX implementation.
+- **Youri "Gawaboumga" Hubaut**: Improving the whole project by making the documentation, improving the code, and more.
+- **Rémi "overdrivr" Bèges**: Made the Noise module.
+
+## Additional thanks
+
+This engine also uses different projects, we obviously thank their respective authors and contributors:
+
+- [Assimp](http://www.assimp.org/): Model loader.
+- [Catch2](https://github.com/catchorg/Catch2): Test framework for C++.
+- [Chimpmunk](http://chipmunk-physics.net/): Physics engine for 2D.
+- [Freetype](https://www.freetype.org/): Font rendering library.
+- [Lua](https://www.lua.org/): Scripting library.
+- [Netwon](http://newtondynamics.com/forum/newton.php): Physics engine for 3D.
+- [Sndfile](http://www.mega-nerd.com/libsndfile/): Audio loader.
+- [Stb](https://github.com/nothings/stb): Image loader.
+- [Utfcpp](http://utfcpp.sourceforge.net/): UTF-8 handler.
+- [OpenAL](https://www.openal.org/): Audio API specification.
+- [OpenGL](https://www.khronos.org/opengl/): Graphics API specification.
+- [Vulkan](https://www.khronos.org/vulkan/): New graphics API specification which replaced OpenGL.