apio/minitar
1
1
Fork 0
Code Issues Pull Requests Releases 15 Activity

Update README.md

Browse Source
This commit is contained in:
apio 2022-11-23 20:50:40 +01:00
parent 408342cb1d
commit 400a51893e
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
# minitar
Tiny C library to interact with tar archives
Tiny and easy-to-use C library to parse tar (specifically, the newer USTAR variant, which is the one pretty much everybody uses) archives
## Example
@ -35,6 +35,10 @@ int main(int argc, char** argv)
The output of this example program when running it with an uncompressed tar archive is identical to that of `tar --list -f archive.tar` with the same uncompressed archive.
## Project structure
The user-facing API (functions defined in `minitar.h` and documented in this README) is implemented in `src/tar.c`. Utility and internally-used functions live in `src/util.c`.
## Functions
### minitar_open
`struct minitar* minitar_open(const char* pathname)`