Skip to content

Commit

Permalink
readme: update
Browse files Browse the repository at this point in the history
- convert embedded links to html
- change local installation instructions
  • Loading branch information
m1stadev committed Apr 22, 2024
1 parent 9aefe79 commit 6cf6e62
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,14 @@ Commands:
- Python 3.8 or higher

## Installation
- Install from [PyPI](https://pypi.org/project/pyimg4/):
- Install from <a href="https://pypi.org/p/pyimg4">PyPI</a>:
- ```python3 -m pip install pyimg4```
- Local installation:
- `./install.sh`
- Requires [Poetry](https://python-poetry.org)
- `pip install --force-reinstall .`

## Notes
- For compression, LZFSE compression utilizes the <a href="https://pypi.org/p/apple-compress">apple-compress</a> library on *OS, 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 *OS (not recommended), you can set the environment variable `PYIMG4_FORCE_LZFSE`.

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

0 comments on commit 6cf6e62

Please sign in to comment.