Started working on the main library (nearly complete)

This commit is contained in:
Caleb Gardner
2023-12-24 08:05:56 -06:00
parent b2a3920c1f
commit 5de59627df
10 changed files with 550 additions and 16 deletions
+2 -2
View File
@@ -4,13 +4,13 @@
A PURE Go library to read squashfs. There is currently no plans to add archive creation support as it will almost always be better to just call `mksquashfs`. I could see some possible use cases, but probably won't spend time on it unless it's requested (open a discussion if you want this feature).
The library has two parts with this `github.com/CalebQ42/squashfs` being easy to use as it implements `io/fs` interfaces and doesn't expose unnecessary information. 95% this is the library you want. If you need lower level access to the information, use `github.com/CalebQ42/squashfs/squashfs` where far more information is exposed.
Currently has support for reading squashfs files and extracting files and folders.
Special thanks to <https://dr-emann.github.io/squashfs/> for some VERY important information in an easy to understand format.
Thanks also to [distri's squashfs library](https://github.com/distr1/distri/tree/master/internal/squashfs) as I referenced it to figure some things out (and double check others).
## [TODO](https://github.com/CalebQ42/squashfs/projects/1?fullscreen=true)
## Limitations
* No Xattr parsing. This is simply because I haven't done any research on it and how to apply these in a pure go way.