Files
parser/README.md
Yves Biener 1fb3ed0496
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m44s
add: README, LICENSE and initial project structure
2025-04-25 18:35:54 +02:00

28 lines
778 B
Markdown

# nf file format - parser
This is a zig library implementing a parser for `nf` files.
> [!CAUTION]
> Only builds using the zig master version are tested to work.
## Usage
To add or update this library as a dependency in your project run the following command:
```sh
zig fetch --save git+https://gitea.yves-biener.de/yves-biener/nf/parser
```
Add the dependency to your module as follows in your *build.zig*:
```zig
const parser: *Dependency = b.dependency("parser", .{
.target = target,
.optimize = optimize,
});
// ...
exe.root_module.addImport("parser", zterm.module("parser"));
```
Or link against the statically linked library of the parser implementation. To allow updates to the parser without requiring a re-build of the using application and/or library.