1

.gitattributes

@@ -0,0 +1,8 @@
+*.cpp		text eol=lf
+*.hpp 		text eol=lf
+*.h 		text eol=lf
+*.c 		text eol=lf
+*.cc 		text eol=lf
+*.txt  		text
+*.vcproj	eol=crlf
+*.sh        eol=lf

Original_README.txt

@@ -0,0 +1,25 @@
+Haaf's Game Engine 1.81
+Copyright (C) 2003-2008, Relish Games
+http://hge.relishgames.com
+
+HGE is an easy to use yet powerful hardware accelerated 2D game engine.
+It is a full featured middleware for all who want to develop commercial
+quality 2D games rapidly and easily. It covers all imaginable 2D game
+genres: you could create everything from a simple puzzle to advanced
+multilayered platformer or strategy without even thinking of any non
+game logic code! And you don't have to know anything about "window
+messages", DirectX programming and all that stuff. Instead you can
+start developing your own game within 15 minutes! 
+
+HGE runs on Microsoft Windows 98, 2000, NT, ME, XP and requires
+DirectX 8.0. It will run even on low-end video cards, including
+built in video cards such as Intel Solano (i815 chipset). HGE can
+be used with virtually any C++ compiler including Visual C++,
+Borland C++, MinGW and Metrowerks Codewarrior. 
+
+See documentation for details.
+See license.txt for licensing information.
+Send any questions, suggestions and bug reports to [email protected].
+
+
+Cheers! :)

readme.txt

@@ -1,25 +1,42 @@
-Haaf's Game Engine 1.81
-Copyright (C) 2003-2008, Relish Games
-http://hge.relishgames.com
-
-HGE is an easy to use yet powerful hardware accelerated 2D game engine.
-It is a full featured middleware for all who want to develop commercial
-quality 2D games rapidly and easily. It covers all imaginable 2D game
-genres: you could create everything from a simple puzzle to advanced
-multilayered platformer or strategy without even thinking of any non
-game logic code! And you don't have to know anything about "window
-messages", DirectX programming and all that stuff. Instead you can
-start developing your own game within 15 minutes! 
-
-HGE runs on Microsoft Windows 98, 2000, NT, ME, XP and requires
-DirectX 8.0. It will run even on low-end video cards, including
-built in video cards such as Intel Solano (i815 chipset). HGE can
-be used with virtually any C++ compiler including Visual C++,
-Borland C++, MinGW and Metrowerks Codewarrior. 
-
-See documentation for details.
-See license.txt for licensing information.
-Send any questions, suggestions and bug reports to [email protected].
-
-
-Cheers! :)
+This is README for HGE library source reconfigured with CMake
+For original readme file refer to Original_README.txt
+=============================================================
+
+INSTALLING
+----------
+This package is configured with CMakeLists.txt for use with CMake. Once ran,
+CMake generates project files for one of known IDE's for Windows (as well as
+Linux/Unix/MacOSX but this version of HGE only builds on Windows).
+
+1. Edit CMakeLists.txt in root folder, set "DIRECTX_SDK_DIR" to where you have
+    "DirectX SDK Summer 2004" installed. If you don't have it yet - visit Microsoft
+    website or search google for "DirectX SDK Summer 2004" (~230 MB download).
+
+2. Run cmake_msvs10_x86.bat for Visual Studio 2010 32bit build (or other bat file,
+    depending what's your IDE).
+
+3. Project directory will be created in HGE181/.build-%YOUR_IDE_VERSION% (for example
+    HGE181/.build-msvs10), open project file (solution file) inside with your IDE and
+    press "BUILD" in your IDE.
+
+4. Resulting library HGE.DLL and HGE.LIB will be placed in HGE181/bin directory, all
+    intermediate libraries will be placed in HGE181/linklib. There is also HGE-STATIC
+    library which doesn't require DLL to run, it can be found in HGE181/linklib.
+
+5. All temporary build files will stay inside .build-*. To clean intermediate files one
+    should delete HGE181/linklib, HGE181/bin and HGE181/.build-* 
+
+IMPORTANT
+---------
+1. If you are going to change any build options, please keep in mind, that this is CMake
+    generated project, editing anything inside .build-* folder will possibly be overwritten
+    next time, when you compile HGE project. If you need to add any compiler options, please
+    edit main or each CMakeLists.txt in HGE181 and HGE181/src/* folders (depending how big
+    your changes are).
+
+2. if you link against HGE library, you only need to mention HGE.LIB in project settings,
+    and have HGE.DLL in your program folder. HGEHELPERS is not needed (its linked internally).
+
+3. if you link against HGE-STATIC flavour of library, you don't need HGE.DLL anymore, all
+    functionality remains ok. You need to mention HGEHELPERS, ZLIB and HGELIBPNG in linker
+    settings of your project for this to work.