]> git.r.bdr.sh - rbdr/super-polarity/blobdiff - README.md
Adds instructions to readme
[rbdr/super-polarity] / README.md
index b7a3bfa4788c4ea67cb8233e4f85c46cb6cdad02..75abbc7e741735f46888c8acbdce76fd0d26a7d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,22 @@
-super-polarity
-==============
+# Super Polarity
 
 A game about magnetic stuff! Sequel to polarity.
+
+# building
+
+Open each project on the appropriate platform (SuperPolarity -> Win
+(VS2k13), SuperPolarityMac -> Mac(Xamarin Studio), SuperPolarityLinux ->
+Linux (MonoDevelop)). The content project must be built in windows, so if 
+you need any content to process, use that version.
+
+This game requires the develop MonoGame. To do that just clone:
+https://github.com/benbeltran/MonoGame or fork it and clone it from
+there in case you want to patch MonoGame and submit pull requests to
+either our fork or upstream.
+
+Just open the MonoGame.framework project for your platform and compile,
+then add the resulting files as references in your project.
+
+# Some vague note about OpenAL
+
+You may want to install openAL