Skip to content
This repository was archived by the owner on Oct 13, 2022. It is now read-only.

Commit 6fcc94e

Browse files
authored
Merge pull request #1 from jhaasdijk/master
Updated README.md. Thanks for this update, @jhaasdijk! Looks better.
2 parents 526a376 + fd0c0a0 commit 6fcc94e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,34 @@ In order to use this repo, you need to have copy of [PeARS, version Orchard](htt
99

1010
## Learn to use your pod locally
1111

12-
1. Clone this repo on your machine:
12+
#### 1. Clone this repo on your machine:
1313

1414
git clone https://github.com/PeARSearch/PeARS-pod.git
1515

16-
17-
2. Setup a virtualenv in your directory (**this step is optional**):
16+
#### 2. Optional step Setup a virtualenv in your directory.
1817

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

21-
3. Install the build dependencies:
20+
#### 3. Install the build dependencies:
2221

2322
pip3 install -r requirements.txt
2423

25-
4. Head over to the app/static/spaces directory and unzip english.dm.zip.
24+
#### 4. Unpack the semantic space
25+
26+
Head over to the app/static/spaces directory and unzip english.dm.zip.
27+
28+
#### 5. Tell your pod what to index.
2629

27-
5. Tell your pod what to index. You should save a csv file containing your pod in the *app/static/pods* folder. If you don't know yet what a csv pod is, consult <a href="https://pearsearch.org/faq.html#newpods">the documentation on PeARS Orchard</a>.
30+
You should save a csv file containing your pod in the *app/static/pods* folder. If you don't know yet what a csv pod is, consult <a href="https://pearsearch.org/faq.html#newpods">the documentation on PeARS Orchard</a>.
2831

29-
6. In the root of the repo, run:
32+
#### 6. Run it!
33+
34+
In the root of the repo, run:
3035

3136
python3 run.py
3237

3338
Now, go to your browser at localhost:5000. You should see your pod running. Happy searching!
3439

35-
3640
## Putting your pod online
3741

3842
You can setup your pod online on any server that will let you run a Flask application with a database. We provide specific instructions for use with <a href="https://www.pythonanywhere.com/">https://www.pythonanywhere.com/</a>. These can be found [on the Wiki](https://github.com/PeARSearch/PeARS-pod/wiki/Deploying-a-PeARS-pod-on-PythonAnywhere).

0 commit comments

Comments
 (0)