status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
YAML implementation for Nim https://nimyaml.org
296 Commits 6 Branches 31 Tags 2.3 MiB
Nim 98.7%
Nix 1.3%
Go to file
Felix Krause 9fffc7b127 Fixed links in documentation 2016-09-22 14:06:54 +02:00
bench Made bench great again 2016-09-21 10:44:40 +02:00
doc Fixed links in documentation 2016-09-22 14:06:54 +02:00
private Restructuring: no more includes 2016-09-20 21:53:38 +02:00
server Made server output syntax-highlighted YAML 2016-05-12 15:35:29 +02:00
test Check for custom object errors when loading 2016-09-21 15:40:03 +02:00
yaml got rid of yaml.common 2016-09-22 13:28:24 +02:00
.gitignore Made test names more consistent 2016-09-20 19:22:31 +02:00
.travis.yml travis fix; added travis badge 2016-09-20 18:33:52 +02:00
CHANGELOG.md Version 0.6.3 2016-07-08 12:08:04 +02:00
README.md travis fix; added travis badge 2016-09-20 18:33:52 +02:00
config.nims Fixed links in documentation 2016-09-22 14:06:54 +02:00
copying.txt Added copyright 2015-12-28 22:22:51 +01:00
nimdoc.cfg got rid of yaml.common 2016-09-22 13:28:24 +02:00
yaml.nim got rid of yaml.common 2016-09-22 13:28:24 +02:00
yaml.nimble Version 0.6.3 2016-07-08 12:08:04 +02:00

README.md

NimYAML - YAML implementation for Nim

Build Status

NimYAML is a pure Nim YAML implementation without any dependencies other than Nim's standard library. It enables you to serialize Nim objects to a YAML stream and back. It also provides a low-level event-based API, and a document object model which you do not want to use because serializing to native types is much more awesome.

Documentation, examples and an online demo are available here. Releases are available as tags in this repository and can be fetched via nimble:

nimble install yaml

Features that may come in the future

  • Serialization:
    • Support for more standard library types
    • Support for polymorphism
    • Support for generic objects
    • Support for transient fields (i.e. object fields that will not be (de-)serialized

Developers

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)

NimYAML needs at least Nim 0.14.0 in order to compile.

License

MIT