From be8d37a9b0549175db6bd7ef9d77baa4f708fb88 Mon Sep 17 00:00:00 2001 From: John Beieler Date: Thu, 22 Oct 2015 13:41:06 -0400 Subject: [PATCH] Update README. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9cec316..e520d71 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ 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 @@ -11,7 +13,8 @@ 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 @@ -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: @@ -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