Add readme

dev
Louis Pearson 2022-08-03 13:09:45 -06:00
parent 6d29253e8c
commit 511bdab4ed
1 changed files with 21 additions and 0 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Zig LDtk
This is a single file library for parsing LDtk JSON files.
## Using
Copy `LDtk.zig` into your project and use like so:
```zig
const LDtk = @import("./LDtk.zig");
// ldtk_file should be a `[]const u8` of the file contents
const ldtk = LDtk.parse(allocator, ldtk_file);
defer ldtk.deinit();
// Now you can access your LDtk data through the `ldtk` struct
for (ldtk.levels) {
// ...
}
```
Alternatively, add this repository as a git submodule.