Skip to content

Commit

Permalink
Merge pull request #15 from jhaasdijk/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
minimalparts authored Oct 14, 2018
2 parents b012e0c + 8a9964e commit 9f61ba1
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

PeARS (version Orchard) is a search engine that you can install and run locally from your browser. It allows you to 'index' pages (i.e. to produce a computer-readable representation of the pages' content, essential to the search process), and to search pages that you or your friends have indexed. Search happens entirely on your machine, meaning that no one knows what you are searching and when.

One feature of PeARS Orchard is the ability to convert a small index into a greyish, unassuming picture, called a 'snow pod'. Snow pods are the mini-weapons of the indexing revolution. They can easily be shared with others by email, on social media, or through any other mean, so you can be your very own search engine, for yourself and for your friends.
One feature of PeARS Orchard is the ability to convert a small index into a greyish, unassuming picture, called a 'snow pod'. Snow pods are the mini-weapons of the indexing revolution. They can easily be shared with others by email, on social media, or through any other means, so you can be your very own search engine, for yourself and for your friends.


### How does this fit with peer-to-peer PeARS?
Expand All @@ -18,37 +18,46 @@ NB: we have some instructions for Windows users [on the wiki](https://github.com

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

git clone https://github.com/PeARSearch/PeARS-orchard.git
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:

sudo apt-get update

sudo apt-get install python3-setuptools
sudo apt-get install python3-setuptools

sudo easy_install3 pip
sudo apt-get install python3-pip

sudo pip3 install virtualenv
sudo pip3 install virtualenv

Then run:

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

Then change into the PeARS-orchard directory:

cd PeARS-orchard

#### 3. Install the build dependencies:

pip3 install -r requirements.txt
pip3 install -r requirements.txt

#### 4. Unpack the semantic space

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

cd app/static/spaces

unzip english.dm.zip

#### 5. Run it!

In the root of the repo, run:

python3 run.py
python3 run.py

Now, go to your browser at localhost:8080. You should see the search page for PeARS. You don't have any pages indexed yet, so go to the F.A.Q. page (link at the top of the page) and follow the short instructions to get you going!

Expand Down

0 comments on commit 9f61ba1

Please sign in to comment.