Files
TrinityCore/README.md
Nay 4559e99e0d Docs: Prettify README
Thanks to Guybrush for the help
2013-07-28 21:17:32 +01:00

81 lines
2.4 KiB
Markdown

# ![logo](http://www.trinitycore.org/f/public/style_images/1_trinitycore.png) TrinityCore
## Introduction
TrinityCore is a *MMORPG* Framework based mostly in C++.
It is derived from *MaNGOS*, the *Massive Network Game Object Server*, and is
based on the code of that project with extensive changes over time to optimize,
improve and cleanup the codebase at the same time as improving the in-game
mechanics and functionality.
It is completely open source; community involvement is highly encouraged.
If you wish to contribute ideas or code please visit our site linked below or
make pull requests to our [Github repository](https://github.com/TrinityCore/TrinityCore).
For further information on the TrinityCore project, please visit our project
website at [TrinityCore.org](http://www.trinitycore.org).
## Requirements
+ Platform: Linux, Windows or Mac
+ Processor with SSE2 support
+ ACE ≥ 5.8.3 (included for Windows)
+ MySQL ≥ 5.1.0 (included for Windows)
+ CMake ≥ 2.8.0
+ OpenSSL ≥ 0.9.8o
+ GCC ≥ 4.3 (Linux only)
+ MS Visual Studio ≥ 9 (2008) (Windows only)
## Install
Detailed installation guides are available in the wiki for
[Windows](http://collab.kpsn.org/display/tc/How-to_Win),
[Linux](http://collab.kpsn.org/display/tc/How-to_Linux) and
[Mac OSX](http://collab.kpsn.org/display/tc/How-to_Mac).
## Reporting issues
Issues can be reported via the [Github issue tracker](https://github.com/TrinityCore/TrinityCore/issues?labels=Branch-3.3.5a).
Please take the time to review existing issues before submitting your own to
prevent duplicates.
In addition, thoroughly read through the [issue tracker guide](http://www.trinitycore.org/f/topic/37-the-trinitycore-issuetracker-and-you/) to ensure
your report contains the required information. Incorrect or poorly formed
reports are wasteful and are subject to deletion.
## Submitting fixes
Fixes are submitted as pull requests via Github. For more information on how to
properly submit a pull request, read the [how-to: maintain a remote fork](http://www.trinitycore.org/f/topic/6037-howto-maintain-a-remote-fork-for-pull-requests-tortoisegit/).
## Copyright
License: GPL 2.0
Read file [COPYING](COPYING)
## Authors & Contributors
Read file [THANKS](THANKS)
## Links
[Site](http://www.trinitycore.org)
[Wiki](http://trinitycore.info)
[Documentation](http://www.trinitycore.net) (powered by Doxygen)
[Forums](http://www.trinitycore.org/f/)