Skip to content

Commit 52f4135

Browse files
assignUserfacebook-github-bot
authored andcommitted
Fix pyvelox description and update readme (facebookincubator#4223)
Summary: Added pip install to readme. Pull Request resolved: facebookincubator#4223 Reviewed By: kagamiori Differential Revision: D43925312 Pulled By: kgpai fbshipit-source-id: d18f14650114eb55a080a3abcdcf92b0d93a3a88
1 parent 1a3783c commit 52f4135

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
inculde *.txt
1+
include *.txt
22
include *.cmake
33
graft CMake
44
graft third_party

pyvelox/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,16 @@ conda create --name pyveloxenv python=3.7
1616
conda activate pyveloxenv
1717
```
1818

19+
### Install PyVelox
20+
21+
You can install PyVelox from pypi without the need to build it from source as we provide wheels for Linux and macOS (x86_64):
22+
```
23+
pip install pyvelox
24+
```
1925

2026
### From Source
2127

22-
Currently PyVelox can only be built from source. You will need Python 3.7 or later and a C++17 compiler.
28+
You will need Python 3.7 or later and a C++17 compiler to build PyVelox from source.
2329

2430

2531
#### Install Dependencies
@@ -33,7 +39,8 @@ On Linux
3339
Run the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-linux-ubuntu-2004-or-later) to install on linux.
3440

3541

36-
#### Install PyVelox
42+
#### Build PyVelox
43+
3744
For local development, you can build with debug mode:
3845
```
3946
make python-build

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
ROOT_DIR = Path(__file__).parent.resolve()
3434

35-
with open("README.md") as f:
35+
with open("pyvelox/README.md") as f:
3636
readme = f.read()
3737

3838

0 commit comments

Comments
 (0)