Skip to content

Commit d8fc4ea

Browse files
committed
Updated manual method for installation to help with some errors I encountered while going through it
1 parent 6b010c1 commit d8fc4ea

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

docs/installation.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
There are several methods for building and setting up a development environment.
55

66
### Manual Method ###
7-
1. Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it
7+
1. Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it.
88
2. Install requirements via pip. For the moment there are two options:
9-
* Install with plain pip using the `requirements`
10-
* Install using Pipenv (which reads from the Pipfile)
9+
* Install with plain pip using `pip install -r requirements.txt`
10+
* Install using Pipenv (which reads from the Pipfile).
1111
3. Build nativepython libraries using `python setup.py build`
12-
4. Append the root of this repository to your `PYTHONPATH`
12+
4. Install typed_python in the site-packages directory using `python setup.py install`
13+
5. Move out of the typed_python root directory, as the source files can interfere with the installed package.
1314

1415
### Pipenv Method ###
1516
This method is simple, and can take care of virtual environment creation and installation for you.
@@ -21,25 +22,20 @@ The included Makefile in this repository contains recipes for building, installi
2122

2223
You can also customize the name and location of any built virtual environments with the `VIRTUAL_ENV` variable.
2324

24-
25-
## Installation ##
25+
## Prerequisites ##
2626

2727
### OSX ###
2828

29-
#### Prerequisites ####
3029
* Python 3.6 (recommended installed with homebrew)
3130
* Currently build is tested against `clang`, not `gcc`. For more information about installing `clang` and configuring your environment see [here](https://embeddedartistry.com/blog/2017/2/20/installing-clangllvm-on-osx)
3231
* It is recommended you use Pipenv ([see this link](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)) to manage the application.
3332
* You can also use virtualenv.
3433
* install Redis (`brew install redis`)
3534

3635

37-
38-
3936
### Linux ###
4037
(These instructions are only for Ubuntu for the moment)
4138

42-
#### Prerequisites ####
4339
Before building the modules in this repository, you will need to make sure that you have the following:
4440
* Python 3.6 with header files (`python3.6-dev python3.6-dbg`)
4541
Note that for development you will also install the debug interpreter.

0 commit comments

Comments
 (0)