Skip to content

Commit

Permalink
Fix pyvelox description and update readme (facebookincubator#4223)
Browse files Browse the repository at this point in the history
Summary:
Added pip install to readme.

Pull Request resolved: facebookincubator#4223

Reviewed By: kagamiori

Differential Revision: D43925312

Pulled By: kgpai

fbshipit-source-id: d18f14650114eb55a080a3abcdcf92b0d93a3a88
  • Loading branch information
assignUser authored and facebook-github-bot committed Mar 9, 2023
1 parent 1a3783c commit 52f4135
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
inculde *.txt
include *.txt
include *.cmake
graft CMake
graft third_party
Expand Down
11 changes: 9 additions & 2 deletions pyvelox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()


Expand Down

0 comments on commit 52f4135

Please sign in to comment.