Skip to content

Commit 64f2d3a

Browse files
authored
docs: Add developer quick start section (#61)
1 parent 4aa3d51 commit 64f2d3a

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,22 @@ about. Bricks in the library fall into three categories:
2525

2626
## Installation
2727

28-
You can install the `unstructured` library with `pip install unstructured`. We also provide
29-
`make` commands to install the library for local development. The `make install-project-local`
30-
command installs `unstructured` into your local Python environment in editable mode. Run
31-
`make help` for a full list of install options.
28+
To install the library, run `pip install unstructured`.
29+
30+
## Developer Quick Start
31+
32+
* Using `pyenv` to manage virtualenv's is recommended
33+
* Mac install instructions. See [here](https://github.com/Unstructured-IO/community#mac--homebrew) for more detailed instructions.
34+
* `brew install pyenv-virtualenv`
35+
* `pyenv install 3.8.13`
36+
* Linux instructions are available [here](https://github.com/Unstructured-IO/community#linux).
37+
38+
* Create a virtualenv to work in and activate it, e.g. for one named `unstructured`:
39+
40+
`pyenv virtualenv 3.8.13 unstructured` <br />
41+
`pyenv activate unstructured`
42+
43+
* Run `make install-project-local`
3244

3345
## Quick Tour
3446

0 commit comments

Comments
 (0)