Wed, 18 Feb 2015 15:13:25 +0000
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 | http://darkgaze.org/pm/page/gorgon-ge |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
8 | https://sourceforge.net/p/gorgon-ge/ |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
9 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
10 | ## Requirements |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
11 | On Linux: |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
12 | GCC 4.8.1+ |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
13 | CMake 2.8+ |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
14 | OpenAL |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
15 | X11 |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
16 | pthread |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
17 | rt |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
18 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
19 | On windows: |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
20 | Visual Studio 2012 or |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
21 | Visual Studio 2013 with multi-byte patch |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
22 | OpenAL |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
23 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
24 | ## Documentation |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
25 | Follow the steps in [GGE_VS_INSTALLATION_TURKISH.pdf](GGE_VS_INSTALLATION_TURKISH.pdf) (in Turkish) |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
26 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
27 | ## License |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
28 | [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
|
29 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
30 | ## Contributing |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
31 | 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
|
32 | |
7b975498d7d5
README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
401
diff
changeset
|
33 | * 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
|
34 | * 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. |