Files
NazaraEngine/readme.md
Lynix 25afa30187 Update README (Add documentation link)
Former-commit-id: b4aa269265f72205b72bf2caae86dd66ab143d44 [formerly a077d845f84b11138cddb6fa3d18127e453f0b9d] [formerly d873b4be5ac6b9a61b4bb9a6d37e9a850b48cf1c [formerly 821300bf9bf03bb400f10d7e1bc6edd9a8213e87]]
Former-commit-id: 7e81e4df215174e322861dd561b8edb6dd13d15c [formerly 746009685b5f0220be1e1b4b91b5736892f7cec6]
Former-commit-id: a7f95ef6f67c61f08ff888ca86887ac760b78f05
2016-09-25 03:27:57 +02:00

52 lines
2.5 KiB
Markdown

Platform | Build Status
------------ | -------------
Windows | [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/dj5qx7axym4uakmy/branch/master?svg=true)](https://ci.appveyor.com/project/DPSLynix/nazaraengine/branch/master)
Linux | [![Travis CI Build Status](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine.svg)](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine)
# 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](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
## Contribute
##### Don't hesitate to contribute to Nazara Engine by:
- Extending the [wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
- 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](https://nazara.digitalpulsesoftware.net)
[Documentation](https://nazara.digitalpulsesoftware.net/doc)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
[Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
[Forum](https://forum.digitalpulsesoftware.net)
## 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
- **Youri "Gawaboumga" Hubaut**: Improving the whole project by making the documentation, improving the code, and more.