zstd/contrib/single_file_decoder/README.md

# Single File Zstandard Decompression Library

The script `combine.sh` creates an _amalgamated_ source file that can be used with or without `zstd.h`. This isn't a _header-only_ file but it does offer a similar level of simplicity when integrating into a project.

Create `zstddeclib.c` from the Zstd source using:
```
cd zstd/contrib/declib
./combine.sh -r ../../lib -r ../../lib/common -r ../../lib/decompress -o zstddeclib.c zstddeclib-in.c
```
Then add the resulting file to your project (see the [example files](examples)).

`create_single_file_decoder.sh` will run the above script, creating file `zstddeclib.c`.
`build_test.sh` will create the decoder, then compile and test the library.

Why?
----

Because all it now takes to support decompressing Zstd is the addition of a single file, two if using the header, with no configuration or further build steps. The library is small, adding, for example, 26kB to an Emscripten compiled WebAssembly project. Native implementations add a little more, 40-70kB depending on the compiler and platform.
Added generator script and simple test The script will combine decompressor sources into a single file. The example shows this in use. 2019-08-23 16:43:29 +00:00			`# Single File Zstandard Decompression Library`

Typo 2019-08-27 14:55:03 +00:00			The script `combine.sh` creates an _amalgamated_ source file that can be used with or without `zstd.h`. This isn't a _header-only_ file but it does offer a similar level of simplicity when integrating into a project.
Added test script; tidied and documented The test script combines the sources then builds and runs an example. A futher example is built if the Emscripten compiler is available on the system. Documentation covers building. 2019-08-27 13:36:06 +00:00
			Create `zstddeclib.c` from the Zstd source using:
Added generator script and simple test The script will combine decompressor sources into a single file. The example shows this in use. 2019-08-23 16:43:29 +00:00			```
			`cd zstd/contrib/declib`
Preparing to run tests Combine script more robust and can output to a specified file. Initial buck files added (work in progress). 2019-08-25 20:49:01 +00:00			`./combine.sh -r ../../lib -r ../../lib/common -r ../../lib/decompress -o zstddeclib.c zstddeclib-in.c`
Added generator script and simple test The script will combine decompressor sources into a single file. The example shows this in use. 2019-08-23 16:43:29 +00:00			```
minor script renaming, for clarity 2019-08-27 23:01:39 +00:00			`Then add the resulting file to your project (see the [example files](examples)).`

			`create_single_file_decoder.sh` will run the above script, creating file `zstddeclib.c`.
			`build_test.sh` will create the decoder, then compile and test the library.
Added test script; tidied and documented The test script combines the sources then builds and runs an example. A futher example is built if the Emscripten compiler is available on the system. Documentation covers building. 2019-08-27 13:36:06 +00:00
Correctness and tidy Test compilation performed with warnings. Author and license added. Test for failing grep on ancient OSX versions. Replaced the test image with something less noisy (which compresses better). 2019-09-02 16:02:50 +00:00			`Why?`
			`----`
Added reasoning 2019-08-27 13:51:14 +00:00
Correctness and tidy Test compilation performed with warnings. Author and license added. Test for failing grep on ancient OSX versions. Replaced the test image with something less noisy (which compresses better). 2019-09-02 16:02:50 +00:00			`Because all it now takes to support decompressing Zstd is the addition of a single file, two if using the header, with no configuration or further build steps. The library is small, adding, for example, 26kB to an Emscripten compiled WebAssembly project. Native implementations add a little more, 40-70kB depending on the compiler and platform.`