From 5e3f2e0f91980a27aeb6e6cde9d3e79bf313b8b8 Mon Sep 17 00:00:00 2001 From: torque Date: Wed, 6 Mar 2024 21:05:52 -0800 Subject: [PATCH] read me --- LICENSE | 19 +++++++++++++++++++ readme.md | 15 +++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 LICENSE create mode 100644 readme.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..54c6b0a --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2024 torque@epicyclic.dev + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6ee8dd2 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ +# ZAYE Ain't a Yaml Emitter + +zaye is a very simple libyaml-based YAML parser for zig. In the spirit of describing +things by defining what they aren't, it is not capable of emitting YAML. If that +changes in the future, then this will have been a poor naming choice. + +## Status + +A single YAML document can be parsed one-shot into a nested tagged-union structure in +zig. No automatic type conversion happens, all scalars left as strings. Most advanced +YAML features are ignored or not supported (e.g. anchors/aliases and tags). + +It does what I need it to do. + +zig 0.11.0 build system for now.