Update readme with easier install directions

dev
Andrew Cassidy 11 months ago
parent 0a66fcca20
commit d4eada16f9

@ -9,12 +9,29 @@ comparable to the original library.
## Installation
To install, first clone this repo and cd into it, then run:
### From Wheel (Easiest)
To install, run
```shell
pip install quicktex
```
If you are on macOS, You need to install openMP from homebrew:
```shell
brew install libomp
```
### From Source
To build from source, first clone this repo and cd into it, then run:
```shell
git submodule update --init
pip install .
```
and setuptools will take care of any dependencies for you.
If you are on macOS, it is recommended to first install openMP from homebrew to enable
@ -31,8 +48,6 @@ required dependencies for them, install with options like so:
pip install .[tests,stubs,docs]
```
Quicktex will be available on Pypi once it is out of alpha.
## Usage
```

Loading…
Cancel
Save