Readme now use Markdown (#20)
Former-commit-id: ecb709c0844b7347b70d031d3303404c85fd258d
This commit is contained in:
48
readme.md
Normal file
48
readme.md
Normal file
@@ -0,0 +1,48 @@
|
||||
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 will 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.
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
Jérôme "Lynix" Leclercq - main developper (Lynix680@gmail.com)
|
||||
Rémi "overdrivr" Bèges - developper & helper - NzNoise 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 : http://wiki.digitalpulsesoftware.com/index.php?title=Nazara:Tutorials
|
||||
|
||||
Contribute
|
||||
----------
|
||||
|
||||
Don't hesitate to contribute to Nazara Engine by :
|
||||
-Extending the wiki at http://wiki.digitalpulsesoftware.com/index.php?title=Nazara
|
||||
-Submitting a patch to GitHub
|
||||
-Post suggestions/bugs on the forum or the GitHub tracker (https://github.com/DigitalPulseSoftware/NazaraEngine/issues)
|
||||
-Fork the project on GitHub and pull your changes (https://github.com/DigitalPulseSoftware/NazaraEngine/pulls)
|
||||
-Talking about Nazara Engine to other people
|
||||
-Doing anything else that might help us
|
||||
|
||||
Links
|
||||
-----
|
||||
|
||||
Website : http://www.digitalpulsesoftware.com
|
||||
Wiki : http://wiki.digitalpulsesoftware.com/index.php?title=Nazara
|
||||
Forum : http://forum.digitalpulsesoftware.com
|
||||
|
||||
Thanks to
|
||||
-RafBill/Raakz: Finding bugs and/or testing
|
||||
-Fissal "DrFisher" Hannoun: Helped a lot in architecture design
|
||||
-Alexandre "Danman" Janniaux: Made the core POSIX port
|
||||
Reference in New Issue
Block a user