diff options
Diffstat (limited to '')
| -rw-r--r-- | src/zstd/contrib/single_file_libs/examples/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/zstd/contrib/single_file_libs/examples/README.md b/src/zstd/contrib/single_file_libs/examples/README.md new file mode 100644 index 000000000..e93bee35f --- /dev/null +++ b/src/zstd/contrib/single_file_libs/examples/README.md @@ -0,0 +1,11 @@ +# Single File ZStandard Examples + +The examples `#include` the generated `zstddeclib.c` directly but work equally as well when including `zstd.h` and compiling the amalgamated source separately. + +`simple.c` is the most basic example of decompressing content and verifying the result. + +`emscripten.c` is a bare-bones [Emscripten](https://github.com/emscripten-core/emscripten) compiled WebGL demo using Zstd to further compress a DXT1 texture (see the [original PNG image](testcard.png)). The 256x256 texture would normally be 32kB, but even when bundled with the Zstd decompressor the resulting WebAssembly weighs in at 41kB (`shell.html` is a support file to run the Wasm). + +`roundtrip.c` is an example to use with the optional [amalgamated library](../create_single_file_library.sh) showing compression the decompression. + +The example files in this directory are released under a [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/) (or Public Domain, whichever is applicable in your jurisdiction). |