Added README.md

Author: Doch88

README.md

@@ -1,2 +1,43 @@
-# SRC
-A 2D Game Engine written in Java
+# :star: SRC :star:
+
+![main](rsc/readme/main.jpg)
+
+By Davide Manco ([Doch88](https://github.com/Doch88)) and Luca Rossi ([luca-rossi](https://github.com/luca-rossi)).
+
+## What is it?
+
+SRC is a university project we developed for the Object-Oriented Programming course in 2017. <br>
+We were young and motivated students, and we wanted to work on a project that was challenging and fun. <br>
+At first, we were thinking about developing yet another game, but then we realized that it was too trivial, and since we are crazy and we like to waste time, we decided to directly write something that could be used to develop games instead.
+
+SRC is a 2D game editor and engine that uses only the Java standard library to work. You can create your platform games and then play them inside the same software. <br>
+It supports basic animations, collisions, portals, simple NPCs, bullets and so on.
+
+Being a student project done during our bachelors years, there are the following problems:
+- We're Italians. It's not a problem per se, but at the time we wrote the code all our comments and variables were in Italian instead of English. Such a bad decision.
+- It uses a MySQL database. The project requirements were specific about using a MySQL database. Before committing to GitHub I managed to embed a MariaDB database (thanks to the MariaDB4J project) inside the software, removing the need of using a separate DBMS. But using such a database still carries some limitations.
+- The code could be better. We were still bachelors students after all.
+
+Another thing that I changed before committing to GitHub is the localization. <br>
+As mentioned, the project was fully in Italian, so I preferred to add some other languages at least during the execution of the software. <br>
+
+## Editor mode
+
+![editor](rsc/readme/editor.jpg)
+
+The Editor mode is the mode used to create new maps and sprites. <br>
+
+It allows to create NPCs, walls and grounds, collectables and so on. <br>
+You can use your own images for the sprites and the animation and define characteristics such as waypoints for the movements or health.
+
+At the bottom there are all the commands is possible to use to move stuff, create new items, delete them etc.
+It is also possible to test the map using the "Start" button.
+
+## Platform mode
+
+![editor](rsc/readme/platform_1.jpg)
+![editor](rsc/readme/platform_2.png)
+![editor](rsc/readme/platform_3.jpg)
+
+Once a game is created, it is possible to play it using the Platform mode, after creating a save entry. <br>
+This mode runs starts from the first map of a game, and unlocks the next ones when the player gets to the end of the map.