NazaraEngine/readme.md

49 lines
2.1 KiB
Markdown

Nazara Engine
=============
Nazara Engine is a fast, complete, cross-platform, object-oriented API which can help you in your daily developper life.
Its goal is to provide a set of useful classes : Its core provides unicode strings, filesystem access, hashs, threads, ...
It also provide a set of libraries, such as audio, network, physics, renderer, 2D and 3D graphics engines, ...
You can use it in any kind of commercial/non-commercial applications without any restriction ([MIT license](http://opensource.org/licenses/MIT)).
Authors
-------
Jérôme "Lynix" Leclercq - main developper (<lynix680@gmail.com>)
Rémi "overdrivr" Bèges - developper & helper - Noise Module - (<remi.beges@laposte.net>)
Install
-------
Use the premake build system in the build directory then compile the engine for your platform.
How to use
----------
You can find tutorials on installation, compilation and use on the [official wiki](http://wiki.digitalpulsesoftware.com/index.php?title=Nazara:Tutorials) (**\*Broken link***)
Contribute
----------
#####Don't hesitate to contribute to Nazara Engine by:#####
- Extending the [wiki](http://wiki.digitalpulsesoftware.com/index.php?title=Nazara) (**\*Broken link***)
- Submitting a patch to GitHub
- Post suggestions/bugs on the forum or the [GitHub tracker](https://github.com/DigitalPulseSoftware/NazaraEngine/issues)
- [Fork the project](https://github.com/DigitalPulseSoftware/NazaraEngine/fork) on GitHub and [push your changes](https://github.com/DigitalPulseSoftware/NazaraEngine/pulls)
- Talking about Nazara Engine to other people
- Doing anything else that might help us
Links
-----
[Website](http://www.digitalpulsesoftware.com)
[Wiki](http://wiki.digitalpulsesoftware.com/index.php?title=Nazara) (**\*Broken link***)
[Forum](http://forum.digitalpulsesoftware.com)
###Thanks to:###
- **RafBill** and **Raakz:** Finding bugs and/or testing
- **Fissal "DrFisher" Hannoun**: Helping a lot in architecture design
- **Alexandre "Danman" Janniaux**: Helping making the POSIX implementation
- **Gawaboumga**: Improving the engine code by merging on GitHub