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

Update readme 

Former-commit-id: 8e947ba710497070000ad834748eb6890e8079e0 [formerly 5cf6c0d507dd97b5b0934472c2a57d3442893cb6] [formerly 9fc16ab88c14c0da4306e040be89c4c6ea54816e [formerly acb28d545ce7d6ba366f69de3a3499a99b063807]]
Former-commit-id: 688f139d2c6ff77cd218cb1319033eb18a63f304 [formerly 92cf401113dac5e442ceed89c403e8fac15d3fef]
Former-commit-id: a94d7513ddbf716c8936840bb8d30dc04da532b5
This commit is contained in:
Lynix 2016-09-22 00:54:04 +02:00
parent f3eaadcd8b
commit 61ea7f3e0e
2 changed files with 38 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
readme.md
View File

@ -1,5 +1,10 @@
Nazara Engine 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. 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, ...
@ -8,26 +13,26 @@ 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)
- Submitting a patch to GitHub - Submitting a patch to GitHub
- Post suggestions/bugs on the forum or the [GitHub tracker](https://github.com/DigitalPulseSoftware/NazaraEngine/issues) - Post suggestions/bugs on the forum or the [GitHub tracker](https://github.com/DigitalPulseSoftware/NazaraEngine/issues)
@ -35,14 +40,16 @@ Contribute
- Talking about Nazara Engine to other people - Talking about Nazara Engine to other people
- Doing anything else that might help us - Doing anything else that might help us
Links ## Links
----- ----------
[Website](http://www.digitalpulsesoftware.net) [Website](https://nazara.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)
###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
- **Youri "Gawaboumga" Hubaut**: Improving the engine code by merging on GitHub - **Youri "Gawaboumga" Hubaut**: Improving the whole project by making the documentation, improving the code, and more.

29
readme_fr.md
View File

@ -1,5 +1,10 @@
Nazara Engine Platforme | 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 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, ...
@ -8,26 +13,26 @@ 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é***)
- Soumettant un patch sur GitHub - Soumettant un patch sur GitHub
- Postant des suggestions/bugs sur le forum ou sur le [tracker GitHub](https://github.com/DigitalPulseSoftware/NazaraEngine/issues) - Postant des suggestions/bugs sur le forum ou sur le [tracker GitHub](https://github.com/DigitalPulseSoftware/NazaraEngine/issues)
@ -35,14 +40,16 @@ Contribution
- Parlant du Nazara Engine à d'autres personnes - Parlant du Nazara Engine à d'autres personnes
- 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](http://www.digitalpulsesoftware.net)
[Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki) [Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
[Forum](http://forum.digitalpulsesoftware.net) [Forum](http://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
- **Youri "Gawaboumga" Hubaut**: Amélioration du code via le merging sur GitHub - **Youri "Gawaboumga" Hubaut**: Amélioration du moteur tant au niveau du code que de sa documentation et du projet en général.