Skip to content

Commit

Permalink
readme: add compression notes
Browse files Browse the repository at this point in the history
  • Loading branch information
m1stadev committed Apr 22, 2024
1 parent 9914353 commit dfc2a0f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,9 @@ Commands:
- `./install.sh`
- Requires [Poetry](https://python-poetry.org)

## Notes
- For compression, LZFSE compression utilizes the <a href="https://pypi.org/p/apple-compress">apple-compress</a> library on macOS, and the <a href="https://pypi.org/p/lzfse">lzfse</a> library on all other OSes (due to libcompression not being available outside of Apple platforms).
- If for some reason you'd like to force the lzfse library to be used on macOS, you can set the environment variable `PYIMG4_FORCE_LZFSE=1`.

## Support
For any questions/issues you have, [open an issue](https://github.com/m1stadev/PyIMG4/issues).

0 comments on commit dfc2a0f

Please sign in to comment.