========================================================================== irrXML 1.2 ========================================================================== Welcome to irrXML Content of this file: 1. Directory structure overview 2. How to use 3. Requirements 5. License 6. Contact ========================================================================== 1. Directory structure overview ========================================================================== You will find some directories after decompressing the archive in which came the SDK. These are: \doc Documentation of irrXML. \example A short example showing how to use the parser with solution and make files. \src The source code of irrXML. ========================================================================== 2. How to use ========================================================================== For Linux/Unix users: Simply go into the directory /example and run 'make'. This will create a sample project using irrXML. Windows users: Just add the source files to your project. That's all. For more information see the documentation in the \doc directory. Alternatively, you could compile irrXML as .lib, after this you would only need to use the irrXML.h header file, nothing more. ========================================================================== 3. Requirements ========================================================================== You can use one of the following compilers/IDEs to develop applications with irrXML. However, other compilers/IDEs make work as well, we simply didn't test them. * gcc 3.2 * gcc 3.3 * Visual Studio 6.0 * Visual Studio.NET (7.0) * Visual Studio.NET 2003 (7.1) * Visual Studio.NET 2005 (8.0) * DevC++ 4.9 & gcc (project files included) ========================================================================== 5. License ========================================================================== The license of irrXML is based on the zlib/libpng license. Even though this license does not require you to mention that you are using the Irrlicht Engine in your product, an acknowledgement would be highly appreciated. The irrXML License =========================== Copyright (C) 2002-2005 Nikolaus Gebhardt This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. ========================================================================== 6. Contact ========================================================================== If you have problems, questions or suggestions, please visit the official homepage of irrXML: http://xml.irrlicht3d.org You will find forums, patches, documentation, and other stuff which will help you out. If want to contact the author of the engine, please send an email to Nikolaus Gebhardt: irrlicht@users.sourceforge.net