README

Fri, 16 Dec 2011 23:21:28 +0000

author
Matthew Wild <mwild1@gmail.com>
date
Fri, 16 Dec 2011 23:21:28 +0000
changeset 0
3ebc0316f54f
permissions
-rw-r--r--

Initial commit with my changes.
Originally imported from yaml-2.0.tar.gz: http://files.luaforge.net/releases/yaml/yaml/0.2/yaml-0.2.tar.gz

0
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 NAME
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 yaml - Lua YAML serialization using LibYAML
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 SYNOPSIS
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 require 'yaml'
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 serialized = yaml.dump({ 1, 2, 3, 4 })
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 content = yaml.load(serialized)
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 DESCRIPTION
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 This module is a Lua binding for Kirill Siminov's excellent LibYAML.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 LibYAML is generally considered to be the best C YAML 1.1 implementation.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 LibYAML 0.1.3 is included as part of this release.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 This module defines the functions dump, load, and configure within the
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 global yaml table.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 Portions of this software were inspired by Perl's YAML::LibYAML module by
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 Ingy döt Net.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 SEE ALSO
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 * LibYAML (http://pyyaml.org/wiki/LibYAML)
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 * luayaml: libsyck YAML binding (http://luaforge.net/projects/luayaml)
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 * YAML::LibYAML (http://search.cpan.org/~nuffin/YAML-LibYAML)
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 AUTHOR
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 Andrew Danforth <acd@weirdness.net>
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 If you are using this module successfully I would love to hear from you.
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 COPYRIGHT
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32 Copyright (c) 2009, Andrew Danforth
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34 THANKS
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35 Thanks to the following people for suggestions and patches:
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
37 Peter Mawhorter
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
38 Cyril Romain
3ebc0316f54f Initial commit with my changes.
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
39 Adrian Sampson

mercurial