* Initial import : dummy sources, autotools conf ready

1 files changed, 41 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..e4b94cb
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+This game is again a clone of lemmings, but meant to be played in battle mode (2 players) thought the network.
+There was a version on ATARI that allows to play with 2 player with a split screen. That's the starting point.
+
+This game is based on SDL 2.0 library.
+
+##############################
+# Original dev envrionnement #
+##############################
+ * Ubuntu 12.04
+ * Default gcc, autoconf, automake, libtool versions from std apt repo
+ * SDL 2.0.0 from source (installed in /usr/local)
+
+##################################
+# Compilation scripts generation #
+##################################
+SDL2.0 use autotools for makefile generation, so I do the same choice hopping that this code will be as portable as SDL.
+
+Hand-crafted files : configure.ac Makefile.am README NEWS ChangeLog
+Command for (re)generation : autoreconf -i
+Generated files : aclocal.m4 autom4te.cache/ build-aux/ mplemmings_config.h.in configure m4/*.m4 Makefile.in COPYING INSTALL
+
+Note : files generated by ./configure : config.log config.status mplemmings_config.h Makefile stamp-h1
+
+################################
+# Compilation and installation #
+################################
+./configure
+make
+sudo make install
+
+####################
+# Playing the game #
+####################
+mplemmings
+(You will have to connect to a game server)
+
+##############################################
+# Starting a dedicated server for mplemmings #
+##############################################
+mplemmings_ds
+(Should be as a linux service, this will come later)