Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Readme: Updated installation instructions
  • Loading branch information
GuardKenzie authored Jan 20, 2023
1 parent a811610 commit 8767e51
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<div align="center" >
<p>&nbsp;</p>
<img width=500 alt="chafa.py" src="https://github.com/GuardKenzie/chafa.py/blob/main/img/logo.svg?raw=true">
<p>&nbsp;</p>
<p>
<em>The snakes don't bite! (I think...)</em>
</p>
Expand Down Expand Up @@ -94,21 +96,11 @@ pip install chafa.py

### From source

If you want, you can install and play around with this package by cloning the repo and building it yourself

```
python -m build
```

in the root of the repository. This will build a distribution file in a new folder: `dist/` called something like `chafa_py-[version].gz`. You can then install this file with pip by running

```
pip install ./dist/chafa_py-[version].tar.gz
```
There are instructions on building chafa.py from source on Windows or Linux in [the docs](https://chafapy.mage.black/usage/installation.html#from-source)

### Dependencies

- [Chafa](https://hpjansson.org/chafa/download/)
- [MagickWand](https://imagemagick.org/script/magick-wand.php)
- [Hatchling](https://pypi.org/project/hatchling/) (for building)
- Python 3.5 or later
- Python 3.8 or later

0 comments on commit 8767e51

Please sign in to comment.