NimYAML/README.md

# NimYAML - YAML implementation for Nim

NimYAML is currently being developed. The current release 0.3.0 is not
considered stable. See [the documentation](http://flyx.github.io/NimYAML/) for
an overview of already available features.

## TODO list

 * Misc:
   - Add type hints for more scalar types
 * Serialization:
   - Support for more standard library types
   - Support polymorphism
   - Support variant objects
   - Support generic objects
   - Support transient fields (i.e. fields that will not be (de-)serialized on
     objects and tuples)
   - Check for and avoid name clashes when generating local tags for custom
     object types.

## Developers

```bash
nim tests # runs unit tests (serialization, dom, json)
          # for parser tests, see yamlTestSuite
nim serializationTests # runs serialization tests
nim documentation # builds documentation to folder docout
nim server # builds the REST server used for the testing ground
nim bench # runs benchmarks, requires libyaml
nim clean # guess
nim build # build a library
nim yamlTestSuite # execute YAML test suite (git-clones yaml-dev-kit)
```

Project is tested against current develop branch of Nim. Older Nim versions
probably do not work.

## License

[MIT](copying.txt)
Added README.md and private/events.nim 2015-12-29 17:38:22 +00:00			`# NimYAML - YAML implementation for Nim`

Version 0.3.0 2016-03-14 17:23:55 +00:00			`NimYAML is currently being developed. The current release 0.3.0 is not`
Updated README with release info 2016-02-16 19:37:01 +00:00			`considered stable. See [the documentation](http://flyx.github.io/NimYAML/) for`
			`an overview of already available features.`
Added README.md and private/events.nim 2015-12-29 17:38:22 +00:00
			`## TODO list`

Sanitized exception handling in serialization 2016-01-24 19:38:30 +00:00			`* Misc:`
Added README.md and private/events.nim 2015-12-29 17:38:22 +00:00			`- Add type hints for more scalar types`
			`* Serialization:`
			`- Support for more standard library types`
Serialization: Support enum types 2016-02-01 19:16:35 +00:00			`- Support polymorphism`
Removed binary file, added TODO items 2015-12-29 17:54:24 +00:00			`- Support variant objects`
Various code style and naming fixes * Renamed some symbols for consistency, fixes #6: - yamlStartSequence -> yamlStartSeq - yamlEndSequence -> yamlEndSeq - yamlStartDocument -> yamlStartDoc - yamlEndDocument -> yamlEndDoc - yTagMap -> yTagMapping * Improved code formatting at some places * Fixed code documentation at some places * Added generic objects to TODO list * Removed obsolete parsing tests, these are superseeded by yaml-dev-kit test suite integration 2016-03-14 17:10:34 +00:00			`- Support generic objects`
Support serializing tuples. Multiple bugfixes. * Parser: Properly support explicit keys in flow style. * Parser: Properly support object tags in flow style. * Serializer: Basic support for tuples. * Serializer: Properly parse int and bool types when given as string with explicit tag. 2016-01-05 15:54:14 +00:00			`- Support transient fields (i.e. fields that will not be (de-)serialized on`
			`objects and tuples)`
More TODOs 2016-01-05 16:00:49 +00:00			`- Check for and avoid name clashes when generating local tags for custom`
			`object types.`
Added README.md and private/events.nim 2015-12-29 17:38:22 +00:00
Improved readme and serialization docs. 2016-02-16 10:05:36 +00:00			`## Developers`

			```bash
Various code style and naming fixes * Renamed some symbols for consistency, fixes #6: - yamlStartSequence -> yamlStartSeq - yamlEndSequence -> yamlEndSeq - yamlStartDocument -> yamlStartDoc - yamlEndDocument -> yamlEndDoc - yTagMap -> yTagMapping * Improved code formatting at some places * Fixed code documentation at some places * Added generic objects to TODO list * Removed obsolete parsing tests, these are superseeded by yaml-dev-kit test suite integration 2016-03-14 17:10:34 +00:00			`nim tests # runs unit tests (serialization, dom, json)`
			`# for parser tests, see yamlTestSuite`
Improved readme and serialization docs. 2016-02-16 10:05:36 +00:00			`nim serializationTests # runs serialization tests`
			`nim documentation # builds documentation to folder docout`
			`nim server # builds the REST server used for the testing ground`
			`nim bench # runs benchmarks, requires libyaml`
			`nim clean # guess`
			`nim build # build a library`
Added option to validate against YAML test suite 2016-03-04 18:10:48 +00:00			`nim yamlTestSuite # execute YAML test suite (git-clones yaml-dev-kit)`
Improved readme and serialization docs. 2016-02-16 10:05:36 +00:00			```

			`Project is tested against current develop branch of Nim. Older Nim versions`
			`probably do not work.`

Added README.md and private/events.nim 2015-12-29 17:38:22 +00:00			`## License`

Improved readme and serialization docs. 2016-02-16 10:05:36 +00:00			`[MIT](copying.txt)`