X-Git-Url: https://git.r.bdr.sh/rbdr/super-polarity/blobdiff_plain/626ab5162bc9b461fde36ab6b6bc58ed066a7945..51df16561ae569385e69b8c16abe7c2650a4c732:/README.md diff --git a/README.md b/README.md index b7a3bfa..224e73e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,36 @@ -super-polarity -============== +# Super Polarity A game about magnetic stuff! Sequel to polarity. + +# Note on Legacy (2018-06-26) + +This is a project I started back in 2014. Things have changed +since then. This project was last updated to build with Visual Studio +for Mac and the stable MonoGame version (3.7.0.1508) + +There are no guarantees that it will build in other platforms (I'll try +to update this, I'm setting up the environment) + +There are no intentions on working on the project any further but the +code is available under an MIT License. I may do some irregular updates +to make sure it continues to build up until the point where legacy +catches up and makes it impractical. + +# Building + +Open each project on the appropriate platform (SuperPolarity -> Win +(VS2k13), SuperPolarityMac -> Mac(Visual Studio for Mac), 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