Permalink
Browse files

Misc updates

Updated CMake cache files
Replaced README with README.md
  • Loading branch information...
1 parent 3ba2056 commit 4a8ab4ba1571097193ddfef3d46069c602e52a1a @gamaral committed Aug 23, 2012
Showing with 51 additions and 56 deletions.
  1. +41 −44 README → README.md
  2. +4 −2 cmake/Cache-32bit.cmake
  3. +2 −5 cmake/Cache-development.cmake
  4. +4 −5 cmake/Cache-release.cmake
View
@@ -1,106 +1,103 @@
-====================================================================================
- Marshmallow Game Engine
-====================================================================================
- “The only game engine that tastes better slightly burned!”
+Marshmallow Game Engine
+=======================
+
+**“The only game engine that tastes better slightly burned!”**
About
-=====
+-----
-*Marshmallow* is a game engine for 8-bit and 16-bit style 2D video games, it
-won’t be limited to such, but most of the base features will focus on that era
-of gaming. This engine will act as the backbone for the Marshmallow
-Entertainment System.
+*marshmallow_h* is an open-source game engine focused on 8-bit and 16-bit era
+2D video games. This engine will act as the backbone and toolkit for the
+Marshmallow Entertainment System.
- http://marshmallow.me/
+<http://marshmallow.me/>
Source
-======
+------
- $ git clone --recursive git://github.com/gamaral/marshmallow_h.git
+ git clone --recursive git://github.com/gamaral/marshmallow_h.git
-Notice the *--recursive* switch, it's needed so that submodules get checked out
-along with the main repository.
+Notice the *--recursive* switch, it's needed so that submodules get checked
+out along with the main repository.
Building
-========
+--------
I include many predefined cmake init-caches, please take a look at the "cmake"
directory in the project root, filenames are pretty self-explanatory.
-Linux/BSD
----------
+### Linux/BSD
Run the following from project root:
- $ cd build
- $ cmake -C ../cmake/Cache-release_glx.cmake ..
- $ make
+ cd build
+ cmake -C ../cmake/Cache-opengl-glx.cmake ..
+ make
Marshmallow's go-to compiler is Clang, the example above uses gcc since it's
almost guaranteed to be on the system (unlike Clang).
-Mac OSX
--------
+### Mac OSX
Run the following from project root using Terminal:
- $ cd build
- $ cmake -G Xcode -C ../cmake/Cache-opengl-qt4.cmake ..
- $ make
+ cd build
+ cmake -G Xcode -C ../cmake/Cache-opengl-qt4.cmake ..
+ make
Launch Xcode and open the project file in the build directory, CGL is currently
unsupported (due to my lazyness, so SDL and QT4 can be used for now).
-Windows
--------
+### Windows
Run the following from project root using the Command Line terminal:
- $ cd build
- $ cmake -C ..\cmake\Cache-opengl-wgl.cmake ..
+ cd build
+ cmake -C ..\cmake\Cache-opengl-wgl.cmake ..
Now open Visual Studio and open the MARSHMALLOW solution located in the build
directory.
Tested on Win7 x86/x64 (VS2010)
-Raspberry Pi
-------------
+### Raspberry Pi
+
+If you wish to test out marshmallow_h on the [Raspberry
+Pi](http://www.raspberrypi.com/), you have two ways of building.
-* Native
+#### Native
Run the following commands in your *marshmallow_h* base:
- $ cd build
- $ cmake -C ../cmake/Cache-raspberrypi.cmake ..
- $ make
+ cd build
+ cmake -C ../cmake/Cache-raspberrypi.cmake ..
+ make
-* Cross-compile
+#### Cross-compile
To start, you will need to clone my RPi toolchain:
- $ git clone --depth 1 git://github.com/gamaral/rpi-toolchain.git
+ git clone --depth 1 git://github.com/gamaral/rpi-toolchain.git
At this point you have the base of the toolchain but no actual submodules, you
will now need to *quick-clone* the submodules:
- $ cd rpi-toolchain
- $ scripts/quick-clone
+ cd rpi-toolchain
+ scripts/quick-clone
The *rpi-toolchain* requires some special environment variables to be exported
in order to work with *marshmallow_h*, this is handled by the nifty *env* file
in the toolchain base:
- $ source rpi-toolchain/env
+ source rpi-toolchain/env
Keep in mind you might need to *source* that same environment file again if you
plan to reconfigure at a later time.
We are now ready to configure *marshmallow_h*, change into the base directory
and run the following commands:
- $ cd build
- $ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-raspberrypi.cmake -C ../cmake/Cache-raspberrypi.cmake ..
- $ make
+ cd build
+ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-raspberrypi.cmake -C ../cmake/Cache-raspberrypi.cmake ..
+ make
-vim:syn=notes:
View
@@ -1,2 +1,4 @@
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32" CACHE STRING "")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32" CACHE STRING "")
+if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUXX)
+ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32" CACHE STRING "")
+ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32" CACHE STRING "")
+endif()
@@ -1,7 +1,4 @@
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -W -Wall" CACHE STRING "")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -W -Wall" CACHE STRING "")
-
set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "")
-set(BUILD_UNIT_TESTS ON CACHE BOOL "")
-set(MARSHMALLOW_DEBUG ON CACHE BOOL "")
+set(BUILD_UNIT_TESTS ON CACHE BOOL "")
+set(MARSHMALLOW_DEBUG ON CACHE BOOL "")
set(MARSHMALLOW_DEBUG_VERBOSITY "1" CACHE STRING "")
@@ -1,5 +1,4 @@
-option(BUILD_UNIT_TESTS "" OFF)
-option(MARSHMALLOW_DEBUG "" OFF)
-
-set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE)
-set(MARSHMALLOW_DEBUG_VERBOSITY "0" CACHE STRING "" FORCE)
+set(CMAKE_BUILD_TYPE "Release" CACHE STRING "")
+set(BUILD_UNIT_TESTS OFF CACHE BOOL "")
+set(MARSHMALLOW_DEBUG OFF CACHE BOOL "")
+set(MARSHMALLOW_DEBUG_VERBOSITY "0" CACHE STRING "")

0 comments on commit 4a8ab4b

Please sign in to comment.