================================================================================
YAML Parser for Javascript
--------------------------------------------------------------------------------
Author: Diogo Costa (costa.h4evr@gmail.com)
Date: 2nd April 2011
================================================================================
DESCRIPTION
This project intends to implement a simple YAML parser. It does not intend to
implement all the aspects formalized in the YAML specs, but rather to implement
a robust parser in Javascript, enough to load simply structured YAML files,
without depending on external libraries and as compatible as possible with all
Javascript-powered browsers.
INSTALLATION
To use the parser, copy 'src/yaml.js' to your javascript-files folder and include it in your page:
<script type="text/javascript" src="yaml.js"></script>
Then use the functions 'YAML.fromURL' or 'YAML.eval' to parse a YAML file.
DOCUMENTATION
In the 'lib' folder, you can find the JSDoc toolkit.
This toolkit is used to generate the documentation for the project.
The documentation is in the folder 'doc'. Use a web browser to visualize 'index.html', the base file of the documentation.
To generate the documentation again, open a terminal and navigate to the folder
where the file 'Makefile' is. Then, run the command 'make'. This will generate
the documentation.
DISCLAIMER
I try to deliver high quality products, but I do not guarantee that the product
is free from defects. Our software is provided "as is", and you use the software
at your own risk.
I make no warranties as to performance, merchantability, fitness for a particular purpose, or any other warranties whether expressed or implied.
Under no circumstances shall I be liable for direct, indirect, special, incidental, or consequential damages resulting from the use, misuse, or inability to use this software, even if I have been advised of the possibility of such damages.
Please consult the license file for more information.