NazaraEngine/readme.md

54 lines
2.9 KiB
Markdown

Platform | Build Status
------------ | -------------
Windows | [![Windows build status](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/windows-build.yml/badge.svg)](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/windows-build.yml)
MSYS2 (MinGW64) | [![Windows build status](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/msys2-build.yml/badge.svg)](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/msys2-build.yml)
Linux | [![Linux build status](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/linux-build.yml/badge.svg)](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/linux-build.yml)
# Nazara Engine
Nazara Engine is a fast, complete, cross-platform, object-oriented API which can help you in your daily developer 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>)
Full Cycle Games - sponsor and contributor from 2017 to 2020.
## 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)
[Discord](https://discord.gg/MvwNx73)
[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.
- **Rémi "overdrivr" Bèges**: Made the Noise module.