Added README

README.md

@@ -0,0 +1,21 @@
+Demonstration mod for FFIopt mod.
+
+**License**: LGPL
+
+# Description
+**ffiopt_demo** provides two demos launchable by chat commands that measure performances of dummy tasks optimized by FFIopt.
+
+You can perform several tests with FFIopt activated or not.
+
+# How to use it
+## PerlinNoise
+Launch the test, issuing ```/pn``` command. Information is outputed both on chat and in logs.
+
+This test is safe for your map.
+
+## VoxelManip
+First, issue a ```/emerge``` to be sure all mapblocks are generated before starting the test.
+
+**BEWARE**: This tests alters the world, do it on a dummy map.
+
+Launch the test, issuing ```/vm``` command. Information is outputed both on chat and in logs.