docs: Add a note about examples to README.md

This commit is contained in:
apio 2023-01-12 20:06:22 +01:00
parent e758012948
commit 8e16524e1c
Signed by: apio
GPG Key ID: B8A7D06E42258954

View File

@ -39,6 +39,8 @@ 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. And in most cases, it's faster as well! 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. And in most cases, it's faster as well!
See [examples](examples/) for more examples using minitar.
## Project structure ## 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`. 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`.