Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
H
Heatshrink
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Grant Kim
Heatshrink
Commits
8fef2674
Commit
8fef2674
authored
12 years ago
by
Scott Vokes
Browse files
Options
Downloads
Patches
Plain Diff
Add basic setup notes to README.
parent
6cddb1dd
No related branches found
Branches containing commit
No related tags found
Tags containing commit
Loading
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+14
-2
14 additions, 2 deletions
README.md
with
14 additions
and
2 deletions
README.md
+
14
−
2
View file @
8fef2674
heatshrink, a data compression/decompression library for embedded/real-time systems.
This is based on [LZSS], since it's particularly suitable for
compression in small amounts of memory.
There is a standalone command-line program,
`heatshrink`
, but the
encoder and decoder can also be used as libraries, independent of each
other. To do so, copy heatshrink.h,
`heatshrink_config.h`
, and either
`heatshrink_encoder.c`
or
`heatshrink_decoder.c`
(and their respective
header) into your project.
Dynamic allocation is used by default, but in an embedded context, you
probably want to statically allocate the encoder/decoder. Set
`HEATSHRINK_DYNAMIC_ALLOC`
to 0 in
`heatshrink_config.h`
.
heatshrink is based on [LZSS], since it's particularly suitable for
compression in small amounts of memory. It can use an optional index to
make compression faster, but otherwise can run in under 100 bytes of
memory.
For more information, see the [blog post] for an overview, and the
`heatshrink_encoder.h`
/
`heatshrink_decoder.h`
header files for API
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment