From d4eada16f94ca08049fd4d11ade815280f31b7f3 Mon Sep 17 00:00:00 2001 From: Andrew Cassidy Date: Wed, 21 Jun 2023 15:11:17 -0700 Subject: [PATCH] Update readme with easier install directions --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5ee1a1c..ad46907 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,32 @@ 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 +If you are on macOS, it is recommended to first install openMP from homebrew to enable multithreading, since it is not included in the default Apple Clang install: ```shell @@ -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 ```