Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnb30 committed Oct 22, 2015
1 parent e17434c commit be8d37a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ PETRARCH
[![Documentation Status](https://readthedocs.org/projects/petrarch2/badge/?version=latest)](http://petrarch2.readthedocs.org/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/openeventdata/petrarch2.svg?branch=master)](https://travis-ci.org/openeventdata/petrarch2)

[![Caerus logo](http://caerusassociates.com/wp-content/uploads/2012/03/Caerus_logo.png)](http://caerusassociates.com/wp-content/uploads/2012/03/Caerus_logo.png

Code for the new Python Engine for Text Resolution And Related Coding Hierarchy (PETRARCH)
event data coder. The coder now has all of the functions from the older TABARI coder
and the new CAMEO.2.0.txt verb dictionary incorporates more syntactic information and is far
simpler than the previous version.


For more information, please read the Petrarch2.pdf file in this directory and visit the (work-in-progress)
[documentation](http://petrarch.readthedocs.org/en/latest/#).
[documentation](http://petrarch2.readthedocs.org/en/latest/#).

##First, a note.

It is possible to run PETRARCH as a stand-alone program. Most of our
Expand All @@ -24,12 +27,8 @@ to explore those options before trying to use PETRARCH as a stand-alone.
##Installing
If you do decide you want to work with Petrarch as a standalone program, it is possible to install:

1) Clone the repo

- For example, download the zip file into ``~/Downloads``.
- This will put the repo into something like ``~/Downloads/petrarch``.

2) Run ``pip install -e ~/Downloads/petrarch``
``pip install git+https://github.com/openeventdata/petrarch2.git``


This will install the program with a command-line hook. You can now run the program using:
Expand Down Expand Up @@ -68,6 +67,8 @@ When you run the program, a ``PETRARCH.log`` file will be opened in the current
working directory. This file will contain general information, e.g., which
files are being opened, and error messages.

But seriously, you should probably use [hypnos](https://github.com/caerusassociates/hypnos) rather than run PETRARCH as a standalone program.

##Unit tests

Commits should always successfully complete the PyTest command
Expand Down

0 comments on commit be8d37a

Please sign in to comment.