diff README @ 52:ab826bc29aa2

Add some documentation, GPLv3 headers, README and COPYING file.
author Thibaut Girka <thib@sitedethib.com>
date Mon, 22 Aug 2011 22:37:14 +0200
parents
children fad7b44cebf2
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+About this project:
+-------------------
+
+This project is an attempt to rewrite the engine behind The Embodiment of Scarlet Devil (EoSD),
+a popular danmaku (bullet hell) game published for Windows by Team Shanghai Alice in 2002.
+Although the main reason behind this project is sheer curiosity, other motivations are portability and extendability.
+Additionally, this project aims for a perfect compatibility with the official game, and thus become some sort of reference implementation.
+
+
+
+Dependencies:
+-------------
+
+    * Python2 (>= 2.6)
+    * Pygame
+    * PyOpenGL
+
+
+
+Documentation:
+--------------
+
+The code should be sufficiently documented for anyone interested to learn how the EoSD engine work,
+but additional documentation is available at:
+http://linkmauve.fr/doc/touhou/