README.md

Wed, 24 Feb 2016 09:47:47 +0000

author
Cem Kalyoncu <cemkalyoncu@gmail.com>
date
Wed, 24 Feb 2016 09:47:47 +0000
changeset 828
0219383302ee
parent 827
fa71e90e1501
child 860
57a40dc13690
permissions
-rw-r--r--

README.md edited online with Bitbucket

629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
1 # Gorgon Game Engine
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
2
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
3 Gorgon Game Engine (GGE) is a C++ game engine that handles many tasks.
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
4
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
5 GGE is a multi-module, interface driven, C++ game engine that handles graphics, animations, sound, multimedia, input, operating system, resource management, simple effects and user interface. Its primary aim is to be easy to program on.
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
6
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
7 https://sourceforge.net/p/gorgon-ge/
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
8
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
9 # GGE 3.x (default branch)
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
10
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
11 ## Requirements
828
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
12 * On Linux:
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
13 * GCC 4.8.1+
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
14 * CMake 2.8+
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
15 * OpenAL
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
16 * X11
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
17 * pthread
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
18 * rt
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
19
828
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
20 * On windows:
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
21 * Visual Studio 2013 with multi-byte patch (not tested), Visual Studio 2015
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
22 * OpenALSoft
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
23 * CMake 2.8+
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
24
828
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
25 ## How to
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
26 Use the examples provided in the Examples directory.
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
27
828
0219383302ee README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 827
diff changeset
28 # GGE 4.x (4.x-dev branch)
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
29
827
fa71e90e1501 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 654
diff changeset
30 GGE 4.x is still in development and is not feature complete.
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
31
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
32 ## Requirements
827
fa71e90e1501 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 654
diff changeset
33 GCC 4.8.1+ / Visual Studio 2015
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
34 CMake 2.8
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
35 X11 (Linux)
827
fa71e90e1501 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 654
diff changeset
36 pthreads (Linux)
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
37 doxygen
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
38 OpenGL
827
fa71e90e1501 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 654
diff changeset
39 libCurl (For HTTP transport)
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
40
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
41 ## Documentation
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
42 http://darkgaze.org/GGEDoc/index.html or can be built using doxygen
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
43
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
44 # License
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
45 [GPL](http://www.gnu.org/copyleft/gpl.html) (commercial use might be allowed depending on the project, please send a mail for details)
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
46
654
44a1e6e27c76 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 630
diff changeset
47 # Contributing
629
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
48 All contributions should be filed on the [sf.net/gorgon-ge](https://hg.code.sf.net/p/gorgon-ge/code) repository.
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
49
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
50 * Fork the repo, push your changes to your fork, and submit a pull request.
7b975498d7d5 README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 401
diff changeset
51 * If something does not work, please report it using [Sourceforge Tickets](https://sourceforge.net/p/gorgon-ge/tickets/) or [Issues](https://bitbucket.org/darkgazeorg/gorgon-game-engine/issues). These issues will then moved to project management system. You will be notified when the issue is solved.

mercurial