From 7ca11f54acc0a228ce355df9c59422dcd1394de1 Mon Sep 17 00:00:00 2001 From: kevin Date: Sun, 20 Dec 2015 13:24:05 -0500 Subject: [PATCH] updated readme --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16eac37..18344c4 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,38 @@ # nlproject NLP Project -how to install: +How to install: - 1. get the NewsReader.tar file from the release. - 2. place within the main folder of the project - 3. execute the bash script install_dependencies.sh + 1. Download the latest release from: -Dependencies: + https://github.com/ktwaco/Temporal-Entity-Annotator-TEA-/releases - 1. make sure you have maven3 and java1.7 or higher installed - 2. make sure you install the python tool py4j: - pip install py4j + 2. Also download the NewsReader.tar file from the release. + + 3. Uncompress NewsReader.tar + + A folder called Temporal-Entity-Annotator-TEA-VERSION should be created + + 4. Place NewsReader.tar within the extracted folder. + + 5. Change current working directory to be the extracted folder. + + 6. Execute the bash script install_dependencies.sh + +External Dependencies: + + - maven3 + - java1.7 or higher + - python2.7 + - py4j, python module + - scikitlearn Environment Variables: - 1. There are two that need to be defined for the system to work: - - TEA_PATH, should be set to the directory containing this README. + 1. There are two that need to be defined for the system to work: + - TEA_PATH, should be set to the the path .../Temporal-Entity-Annotator-TEA-VERSION + - PY4J_DIR_PATH, should be set to the folder /share/py4j, created when installing py4j. - It should contain the contain the file py4j0.8.2.1.jar + - It should contain the contain the file py4j0.8.2.1.jar +