Updating the readme

.travis.yml

@@ -15,10 +15,12 @@ install:
   - export CC="gcc-4.8"
 
 script:
-  - echo `$CC --version`
   - cd build
-  - cmake .. -DANKI_BUILD_TOOLS=OFF
-  - make -j 2
+  - cmake .. -DANKI_OPTIMIZE=ON -DANKI_DEBUG=OFF -DANKI_DEBUG_SYMBOLS=OFF -DANKI_BUILD_TOOLS=ON -DANKI_BUILD_TESTS=ON -DANKI_ENABLE_COUNTERS=OFF
+  - make
+  - ./clean.sh
+  - cmake .. -DANKI_OPTIMIZE=OFF -DANKI_DEBUG=ON -DANKI_DEBUG_SYMBOLS=ON -DANKI_BUILD_TOOLS=ON -DANKI_BUILD_TESTS=ON -DANKI_ENABLE_COUNTERS=ON
+  - make
 
 branches:
   only:
@@ -27,7 +29,6 @@ branches:
 notifications:
   email: false
 
-os:
-  - linux
+os: linux
 
 

CMakeLists.txt

@@ -41,7 +41,7 @@ option(ANKI_OPTIMIZE "Optimize" ON)
 option(ANKI_DEBUG_SYMBOLS "Debug symbols" OFF)
 option(ANKI_DEBUG "Debugging checks" OFF)
 
-option(ANKI_BUILD_TOOLS "Build tools" ON)
+option(ANKI_BUILD_TOOLS "Build tools" OFF)
 option(ANKI_BUILD_TESTS "Build unit tests" OFF)
 option(ANKI_BUILD_TESTAPP "Build test application" ON)
 option(ANKI_BUILD_BENCH "Build benchmark application" OFF)

README.md

@@ -1,6 +1,10 @@
-AnKi 3D engine is a Linux opensource game engine build using OpenGL 4.4.
+[![Build Status](https://travis-ci.org/godlikepanos/anki-3d-engine.svg?branch=master)](https://travis-ci.org/godlikepanos/anki-3d-engine)
 
-## License
+AnKi 3D engine is a Linux and Windows opensource game engine that runs on
+OpenGL 4.4.
+
+License
+=======
 
 AnKi's license is BSD. This practicaly means that you can use the source or
 parts of the source on proprietary and non proprietary products as long as you
@@ -8,29 +12,54 @@ follow the conditions of the license.
 
 See LICENSE file for more info.
 
-## Building AnKi
+Building AnKi
+=============
 
-AnKi's build system is using CMake. A great effort was made to keep the number 
-of external dependencies to minimum so the only prerequisites are the following:
+AnKi's build system is using CMake. A great effort was made to ease the building
+process that's why the number of external dependencies are almost none.
 
-- X11 development files (Package name under Ubuntu: libx11-dev)
-- Mesa GL development files (Package name under Ubuntu: mesa-common-dev)
+On Linux
+--------
 
-AnKi is using the C++11 standard so the supported compilers are:
+Prerequisites:
 
-- GCC 4.8 or greater 
-- clang 3.3 or greater 
+- Cmake 2.8 and up
+- GCC 4.8 and up or Clang 3.5 and up
 
 To build the release version:
 
 	$cd <path_to_anki>/build
-	$cmake -DANKI_BUILD_TYPE=Release ..
+	$cmake ..
 	$make
 
-To view and configure the build options you can use ccmake tool or similar app:
+To view and configure the build options you can use ccmake tool or similar:
 
 	$cd <path_to_anki>/build
 	$ccmake .
 
 This will open an interface with all the available options.
 
+On Windows
+----------
+
+Prerequisites:
+
+- CMake 2.8 and up
+- Mingw-w64 4.8 and up
+	- Install to a path without spaces
+	- Append the path where mingw's binaries are located (eg
+	  C:/mingw-w64/x86_64-4.9.3-win32-seh-rt_v4-rev1/mingw64/bin) to the PATH
+	  environment variable
+
+To build the release version:
+
+- Open CMake GUI tool
+	- Point the source directory to where AnKi's CMakeLists.txt is located
+	- Select a build directory
+	- Configure by selecting mingw makefiles
+	- Generate the makefiles
+- Open a PowerShell
+	- Navigate to where the build directory is located
+	- Invoke the mingw's make: mingw32-make
+
+> NOTE: If you have a better way to build on Windows please let us know.