diff --git a/MANIFEST.in b/MANIFEST.in index 0973e62d9e72..5ae301c04bf0 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -inculde *.txt +include *.txt include *.cmake graft CMake graft third_party diff --git a/pyvelox/README.md b/pyvelox/README.md index f3fb46ffb92b..acf3c7c9949e 100644 --- a/pyvelox/README.md +++ b/pyvelox/README.md @@ -16,10 +16,16 @@ conda create --name pyveloxenv python=3.7 conda activate pyveloxenv ``` +### Install PyVelox + +You can install PyVelox from pypi without the need to build it from source as we provide wheels for Linux and macOS (x86_64): +``` +pip install pyvelox +``` ### From Source -Currently PyVelox can only be built from source. You will need Python 3.7 or later and a C++17 compiler. +You will need Python 3.7 or later and a C++17 compiler to build PyVelox from source. #### Install Dependencies @@ -33,7 +39,8 @@ On Linux Run the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-linux-ubuntu-2004-or-later) to install on linux. -#### Install PyVelox +#### Build PyVelox + For local development, you can build with debug mode: ``` make python-build diff --git a/setup.py b/setup.py index c5a445e82d30..4e09e3aa3d78 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ ROOT_DIR = Path(__file__).parent.resolve() -with open("README.md") as f: +with open("pyvelox/README.md") as f: readme = f.read()