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

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
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
Show Stats 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) Linux | [![Travis CI Build Status](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine.svg)](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine)
# Nazara Engine # Nazara Engine
-------
Nazara Engine is a fast, complete, cross-platform, object-oriented API which can help you in your daily developper life. 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, ... 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)). You can use it in any kind of commercial/non-commercial applications without any restriction ([MIT license](http://opensource.org/licenses/MIT)).
## Authors ## Authors
-------
Jérôme "Lynix" Leclercq - main developper (<lynix680@gmail.com>) Jérôme "Lynix" Leclercq - main developper (<lynix680@gmail.com>)
Rémi "overdrivr" Bèges - developper & helper - Noise Module - (<remi.beges@laposte.net>) Rémi "overdrivr" Bèges - developper & helper - Noise Module - (<remi.beges@laposte.net>)
## Install ## Install
-------
Use the premake build system in the build directory then compile the engine for your platform. Use the premake build system in the build directory then compile the engine for your platform.
## How to use ## How to use
----------
You can find tutorials on installation, compilation and use on the [official wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) You can find tutorials on installation, compilation and use on the [official wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
## Contribute ## Contribute
----------
##### Don't hesitate to contribute to Nazara Engine by: ##### Don't hesitate to contribute to Nazara Engine by:
- Extending the [wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) - 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 - Doing anything else that might help us
## Links ## Links
----------
[Website](https://nazara.digitalpulsesoftware.net) [Website](https://nazara.digitalpulsesoftware.net)
[Documentation](https://nazara.digitalpulsesoftware.net/doc)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
[Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) [Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
[Forum](https://forum.digitalpulsesoftware.net) [Forum](https://forum.digitalpulsesoftware.net)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
## Thanks to: ## Thanks to:
----------
- **RafBill** and **Raakz:** Finding bugs and/or testing - **RafBill** and **Raakz:** Finding bugs and/or testing
- **Fissal "DrFisher" Hannoun**: Helping a lot in architecture design - **Fissal "DrFisher" Hannoun**: Helping a lot in architecture design
- **Alexandre "Danman" Janniaux**: Helping making the POSIX implementation - **Alexandre "Danman" Janniaux**: Helping making the POSIX implementation

16
readme_fr.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) Linux | [![Travis CI Build Status](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine.svg)](https://travis-ci.org/DigitalPulseSoftware/NazaraEngine)
# Nazara Engine # Nazara Engine
-------
Nazara Engine est une API rapide, complète, portable et orientée-objet qui peut vous aider dans votre vie de développeur de tous les jours. Nazara Engine est une API rapide, complète, portable et orientée-objet qui peut vous aider dans votre vie de développeur de tous les jours.
Son objectif est de fournir un ensemble de classes utiles : Son noyau dispose de chaînes de caractères unicode, de gestion du système de fichiers, hashs, threads, ... Son objectif est de fournir un ensemble de classes utiles : Son noyau dispose de chaînes de caractères unicode, de gestion du système de fichiers, hashs, threads, ...
@ -14,23 +13,19 @@ Il propose aussi un ensemble de bibliothèques, comme audio, réseau, physique,
Vous pouvez également l'utiliser pour toute application commerciale sans aucune contrainte ([Licence MIT](http://opensource.org/licenses/MIT)). Vous pouvez également l'utiliser pour toute application commerciale sans aucune contrainte ([Licence MIT](http://opensource.org/licenses/MIT)).
## Auteurs ## Auteurs
-------
Jérôme "Lynix" Leclercq - développeur principal (<lynix680@gmail.com>) Jérôme "Lynix" Leclercq - développeur principal (<lynix680@gmail.com>)
Rémi "overdrivr" Bèges - développeur & aide - module Noise - (<remi.beges@laposte.net>) Rémi "overdrivr" Bèges - développeur & aide - module Noise - (<remi.beges@laposte.net>)
## Installation ## Installation
------------
Utilisez le système premake pour construire le projet du moteur, dans le dossier build, pour ensuite compiler le moteur pour votre plateforme. Utilisez le système premake pour construire le projet du moteur, dans le dossier build, pour ensuite compiler le moteur pour votre plateforme.
## Utilisation ## Utilisation
-----------
Vous pouvez lire des tutoriaux sur l'installation, la compilation et l'utilisation sur le [wiki officiel](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) (**\*En cours de rédaction***) Vous pouvez lire des tutoriaux sur l'installation, la compilation et l'utilisation sur le [wiki officiel](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) (**\*En cours de rédaction***)
## Contribution ## Contribution
----------
##### N'hésitez pas à contribuer à Nazara Engine en : ##### N'hésitez pas à contribuer à Nazara Engine en :
- Contribuant au [wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) (**\*Lien brisé***) - Contribuant au [wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) (**\*Lien brisé***)
@ -41,14 +36,15 @@ Vous pouvez lire des tutoriaux sur l'installation, la compilation et l'utilisati
- Faisant n'importe quoi d'autre qui pourrait nous aider - Faisant n'importe quoi d'autre qui pourrait nous aider
## Liens ## Liens
----------
[Website](http://www.digitalpulsesoftware.net) [Website](https://nazara.digitalpulsesoftware.net)
[Documentation](https://nazara.digitalpulsesoftware.net/doc)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
[Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) [Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
[Forum](http://forum.digitalpulsesoftware.net) [Forum](https://forum.digitalpulsesoftware.net)
[Mattermost](https://mattermost.digitalpulsesoftware.net)
###Remerciements: ###Remerciements:
----------
- **RafBill** et **Raakz:** Recherche de bugs et/ou tests - **RafBill** et **Raakz:** Recherche de bugs et/ou tests
- **Fissal "DrFisher" Hannoun**: Aide et conseils lors de la conception de l'architecture du moteur - **Fissal "DrFisher" Hannoun**: Aide et conseils lors de la conception de l'architecture du moteur
- **Alexandre "Danman" Janniaux**: Aide sur l'implémentation POSIX - **Alexandre "Danman" Janniaux**: Aide sur l'implémentation POSIX