sid/NazaraEngine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README (Add documentation link)

Browse Source 
Former-commit-id: b4aa269265f72205b72bf2caae86dd66ab143d44 [formerly a077d845f84b11138cddb6fa3d18127e453f0b9d] [formerly d873b4be5ac6b9a61b4bb9a6d37e9a850b48cf1c [formerly 821300bf9bf03bb400f10d7e1bc6edd9a8213e87]]
Former-commit-id: 7e81e4df215174e322861dd561b8edb6dd13d15c [formerly 746009685b5f0220be1e1b4b91b5736892f7cec6]
Former-commit-id: a7f95ef6f67c61f08ff888ca86887ac760b78f05
This commit is contained in:
Lynix
2016-09-25 03:27:57 +02:00
parent 48ef3f6b30
commit 25afa30187
2 changed files with 11 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@@ -4,7 +4,6 @@ Windows | [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/
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, ...
@@ -14,23 +13,19 @@ It also provide a set of libraries, such as audio, network, physics, renderer, 2
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)
@@ -41,14 +36,15 @@ You can find tutorials on installation, compilation and use on the [official wik
- 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)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
[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