/*
 * $Id: README.txt,v 1.3 2004/08/04 14:27:37 nunnari Exp $
 *
 * Copyright (c) 2004 Roberto Nunnari - roberto.nunnari@nunnisoft.ch
 * All rights reserved.
 *
 *  This file is part of NunniMCAX.
 *
 *  NunniMCAX is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NunniMCAX is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with NunniFSMGen; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

===============================================================================

Abstract:
========
NunniMCAX is a C, non validating XML parser. Its APIs and functioning
are inspired on and just a minimal subset of SAX. That means that if you're
familiar with SAX it will be straitforward to start using it.

The latest releases of NunniMCAX are available at:
http://nunnimcax.nunnisoft.ch

NunniMCAX has been built using an Open Source FSM (Finite State Machine)
generator, namely NunniFSMGen, available at http://nunnifsmgen.nunnisoft.ch

NunniMCAX is not and don't intend to be a competitor of xerces, expat, etc.
The aim of NunniMCAX is to be a lightweight, fast and reliable XML parser
in environments with limited resources (embedded, mobiles, etc..).

NunniMCAX doesn't do entity expansion.

Contact information:
===================
For any comment, feature request, bug report or just to tell a success story
about NunniMCAX, please contact me at roberto.nunnari@nunnisoft.ch

Documentation:
=============
Up to date documentation is available at http://nunnimcax.nunnisoft.ch

Build the library:
=================
- on unix simply cd into the distribution and type 'make'
- on windows use the project files for Visual C++ and build all

Compile and link your application against NunniMCAX:
===================================================
- include NunniMCAX.h in your source files
- link your application with '-lNunniMCAX'

Run the example:
===============
When building, the example vai is build from vai.c.
You can try running that on the xml examples like this:
on unix:
  $ ./vai server.xml
on windows:
  > .\vai.exe server.xml

Short and incomplete how-to:
===========================
See the example in vai.c

Enjoy!
