Page MenuHomePhabricator (Chris)

No OneTemporary

Authored By
Unknown
Size
5 KB
Referenced Files
None
Subscribers
None
diff --git a/README b/README
deleted file mode 100644
index 1daf991..0000000
--- a/README
+++ /dev/null
@@ -1,76 +0,0 @@
-Me and My Shadow
-====================
-Me and My Shadow is a free libre puzzle/platform game in which you try to reach
-the exit by solving puzzles. Spikes, moving blocks, fragile blocks and much
-more stand between you and the exit. Record your moves and let your shadow
-mimic them to reach blocks you couldn't reach alone.
-
- - Tutorial for beginners
- - 2 level packs containing over 40 levels
- - 18 different block types
- - Built-in level editor
- - Easily installable addons
- - Original music by Juho-Petteri Yliuntinen
- - Cross platform
-
-
-
-Compiling on Linux
-====================
-
-You will need the following packages (and their -dev(el) files) to be installed:
-
- * libSDL
- * libSDL_image
- * libSDL_ttf
- * libSDL_mixer
- * libSDL_gfx
- * libcurl
- * libarchive
- * cmake
- * C++ compiler (found in packages like g++, gcc-c++, gcc)
-
-The process is simple. Enter a terminal and move to directory containing
-MeAndMyShadow. Then just type
-
- cmake .
-
-to generate the Makefile. If everything configured properly you don't see any
-errors and then you can start compiling by typing
-
- make
-
-Finally you can run MeAndMyShadow with
-
- ./meandmyshadow
-
-To install MeAndMyShadow on your system, run following as root
-
- make install
-
-
-
-Compiling without GL
-====================
-In some cases you might want to compile Me and My Shadow without openGL
-hardware accelaration. In order to do this follow the steps above but replace the
-cmake call with:
-
- cmake -DHARDWARE_ACCELERATION=OFF .
-
-Note that you can always run Me and My Shadow in SDL mode by setting gl to 0 in
-the config file or by running it as following:
-
- meandmyshadow -set gl 0
-
-Compiling on Mac
-====================
-You need to have Xcode 4+ and following frameworks:
-
- * SDL.framework
- * SDL_image.framework
- * SDL_ttf.framewrok
- * SDL_mixer.framework
- * SDL_gfx.framework
-
-Offical SDL binaries builded not builded for embeding with app. So you need to build them from sources or use unofficial binaries, please refer to this article: http://thirdcog.eu/apps/frameworks
diff --git a/README.md b/README.md
index 50cd179..1f13e9d 100644
--- a/README.md
+++ b/README.md
@@ -1,83 +1,92 @@
-(new README under construction)
-
[![Build Status](https://travis-ci.org/acmepjz/meandmyshadow.svg?branch=master)](https://travis-ci.org/acmepjz/meandmyshadow)
[![Build status](https://ci.appveyor.com/api/projects/status/t0cfcb54fppa501c/branch/master?svg=true)](https://ci.appveyor.com/project/acmepjz/meandmyshadow/branch/master) <--
Click here for Windows nightly build (you also need `data` forder from latest git repository, just download from GitHub)
Me and My Shadow
====================
Me and My Shadow is a free libre puzzle/platform game in which you try to reach
the exit by solving puzzles. Spikes, moving blocks, fragile blocks and much
more stand between you and the exit. Record your moves and let your shadow
mimic them to reach blocks you couldn't reach alone.
- Tutorial for beginners
- 2 level packs containing over 40 levels
- 18 different block types
- Built-in level editor
- Easily installable addons
- Original music by Juho-Petteri Yliuntinen
- Cross platform
Compiling on Linux
====================
You will need the following packages (and their -dev(el) files) to be installed:
- * libSDL
- * libSDL_image
- * libSDL_ttf
- * libSDL_mixer
- * libSDL_gfx
+ * libSDL2
+ * libSDL2_image
+ * libSDL2_ttf
+ * libSDL2_mixer
* libcurl
* libarchive
+ * liblua ( >=5.2 )
* cmake
* C++ compiler (found in packages like g++, gcc-c++, gcc)
The process is simple. Enter a terminal and move to directory containing
MeAndMyShadow. Then just type
- cmake .
+~~~
+ mkdir build && cd build
+ cmake ..
+~~~
to generate the Makefile. If everything configured properly you don't see any
errors and then you can start compiling by typing
+~~~
make
+~~~
Finally you can run MeAndMyShadow with
+~~~
./meandmyshadow
+~~~
To install MeAndMyShadow on your system, run following as root
+~~~
make install
+~~~
+See `.travis.yml` for example.
-
-Compiling without GL
+Compiling on Windows
====================
-In some cases you might want to compile Me and My Shadow without openGL
-hardware accelaration. In order to do this follow the steps above but replace the
-cmake call with:
- cmake -DHARDWARE_ACCELERATION=OFF .
+If you are using VS2013 or VS2015 you can download the pre-built SDL2 dependencies
+[here](https://github.com/acmepjz/meandmyshadow/releases/tag/v0.5-devel002 ),
+and unzip the dependencies.
+Otherwise you need to compile some dependencies from source. See `appveyor.yml-build-dependencies` for example.
-Note that you can always run Me and My Shadow in SDL mode by setting gl to 0 in
-the config file or by running it as following:
+Open a command prompt, move to directory containing
+MeAndMyShadow. Then type
- meandmyshadow -set gl 0
+~~~
+ set PATH=path\to\dependencies;%PATH%
+ mkdir build && cd build
+ path\to\cmake-gui.exe ..
+~~~
+
+Follow the instruction to generate Visual Studio solution files.
+Open the solution file to compile.
Compiling on Mac
====================
-You need to have Xcode 4+ and following frameworks:
-
- * SDL.framework
- * SDL_image.framework
- * SDL_ttf.framewrok
- * SDL_mixer.framework
- * SDL_gfx.framework
+(Under construction)
-Offical SDL binaries builded not builded for embeding with app. So you need to build them from sources or use unofficial binaries, please refer to this article: http://thirdcog.eu/apps/frameworks
+It is almost the same as in Linux. Use brew to install dependencies.
+See `.travis.yml` for example.

File Metadata

Mime Type
text/x-diff
Expires
Tue, Jun 16, 12:16 AM (2 w, 2 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
71239
Default Alt Text
(5 KB)

Event Timeline