Skip to content

Commit

Permalink
README.md: Note that compression settings are not expressed in output.
Browse files Browse the repository at this point in the history
Closes #56.
  • Loading branch information
silentbicycle committed Jul 4, 2021
1 parent 50cef1a commit e4084ca
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ usage and how effectively it can compress data. These are set when
dynamically allocating an encoder or decoder, or in `heatshrink_config.h`
if they are statically allocated.

Note that the configuration parameters are not explicitly represented in
the compressed output -- in most use cases, either the configuration
settings will remain constant and can be implicit, or there will be some
kind of project-specific protocol envelope / header to contain that
information.


- `window_sz2`, `-w` in the CLI: Set the window size to 2^W bytes.

The window size determines how far back in the input can be searched for
Expand Down

0 comments on commit e4084ca

Please sign in to comment.