add: README, LICENSE and initial project structure
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m44s
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m44s
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# 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.
|
||||
Reference in New Issue
Block a user