| | 1 | = Documentation = |
| | 2 | |
| | 3 | == Documentation is in progress == |
| | 4 | |
| | 5 | == Getting started == |
| | 6 | |
| | 7 | A following code snippet shows you how to start working with the engine. It will initialize the engine singleton and setup a basic logging capabilities. |
| | 8 | |
| | 9 | {{{ |
| | 10 | |
| | 11 | #include <nrEngine/nrEngine.h> |
| | 12 | |
| | 13 | void main() |
| | 14 | { |
| | 15 | // initialize logging |
| | 16 | Engine::instance()->initializeLog("log/"); |
| | 17 | Engine::sLog()->setLevel(Log::LL_WARNING); |
| | 18 | |
| | 19 | // initialiye essential parts of the engine |
| | 20 | Engine::instance()->initializeEngine(); |
| | 21 | |
| | 22 | |
| | 23 | .... |
| | 24 | |
| | 25 | |
| | 26 | // release the engine and free memory |
| | 27 | Engine::release(); |
| | 28 | } |
| | 29 | |
| | 30 | |
| | 31 | }}} |
