diff options
| -rw-r--r-- | README.md | 48 | ||||
| -rw-r--r-- | pom.c | 5 |
2 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3177389 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# libpom + +C parser for [POM configuration language](https://pom.computer) + +## Basic usage + +```c +#include <stdlib.h> +#include <pom.h> + +int main(void) { + pom_error *error; + pom_conf *conf = pom_load_path("conf.pom", &error); + if (!conf) { + pom_error_print(error); + free(error); + return EXIT_FAILURE; + } + const char *indentation_type = pom_conf_get(conf, "indentation-type"); + if (indentation_type) + printf("Indenting with %s\n", indentation_type); + else + printf("No indentation type set!\n"); + pom_conf_free(conf); +} +``` + +See `examples/` directory for more examples. + +## Contributing + +Contributions are welcome, including bug fixes, examples, improvements +to documentation or code readability, and error message translations (see `errors.c`). + +## License + +```text +Permission to use, copy, modify, and/or distribute this software for +any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL +WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE +FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY +DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN +AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +``` @@ -1,3 +1,8 @@ +/* +TODO: +- clean up read_conf.c example +- tests +*/ #include "pom.h" #include <stdio.h> // still needed for sprintf, even if POM_NO_STDIO is defined. |