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

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
minimalparts committed Aug 16, 2018
1 parent 5e9792d commit 526a376
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# PeARS Pod
----

## What and why

PeARS Pod is for people who want to 'look like a search engine', and wish to set up an online PeARS pod with a fixed URL. An example PeARS pod can be found [here](http://www.openmeaning.org/pod0/). **Note that setting up a pod with a URL is not necessary to share your Web knowledge!** PeARS also lets you share indexes with your friends via text files and images. This repo is purely for people who would like to setup a permanent online page where visitors can search their pod.

In order to use this repo, you need to have copy of [PeARS, version Orchard](https://github.com/PeARSearch/PeARS-orchard) installed on your computer, which you will specifically use to prepare your pod. If you are using PeARS for your own general purposes at the same time, we advise you to keep two copies of Orchard in two different directories. For instance, you may have one Orchard instance in your home directory for private purposes, and another install in a *your-pod-name* directory, alongside your PeARS Pod install.


----
## Learn to use your pod locally

1. Clone this repo on your machine:
Expand Down Expand Up @@ -36,4 +35,4 @@ Now, go to your browser at localhost:5000. You should see your pod running. Happ

## Putting your pod online

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.
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 comments on commit 526a376

Please sign in to comment.