Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
minimalparts committed Mar 8, 2018
1 parent 458dfb8 commit 1ab82c8
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Expand Up @@ -16,12 +16,14 @@ The fully-fledged PeARS system (Peer-to-peer Agent for Reciprocated Search) is s

NB: we have some instructions for Windows users [on the wiki](https://github.com/PeARSearch/PeARS-orchard/wiki/Windows-installation).

### 1. Clone this repo on your machine:
#### 1. Clone this repo on your machine:

git clone https://github.com/PeARSearch/PeARS-orchard.git


### 2. **Optional step** Setup a virtualenv in your directory. If you haven't yet set up virtualenv on your machine, please install it via pip:
#### 2. **Optional step** Setup a virtualenv in your directory.

If you haven't yet set up virtualenv on your machine, please install it via pip:


sudo apt-get install python3-setuptools
Expand All @@ -34,13 +36,17 @@ Then run:

virtualenv -p python3 env && source env/bin/activate

### 3. Install the build dependencies:
#### 3. Install the build dependencies:

pip3 install -r requirements.txt

### 4. Head over to the app/static/spaces directory and unzip english.dm.zip.
#### 4. Unpack the semantic space

Head over to the app/static/spaces directory and unzip english.dm.zip.

#### 5. Run it!

### 5. In the root of the repo, run:
In the root of the repo, run:

python3 run.py

Expand Down

0 comments on commit 1ab82c8

Please sign in to comment.