From 5927ca5589e3b41136aa884062fadef8c34eb2ad Mon Sep 17 00:00:00 2001 From: Yigit Sever Date: Wed, 18 Sep 2019 00:04:38 +0300 Subject: Add requirements and basic usage --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a2dc1b4..c87fe29 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ # Evaluating cross-lingual textual similarity on dictionary alignment -This repository contains the scripts to prepare the resources we have used for our study as well as open source implementations of the methods. +This repository contains the scripts to prepare the resources for the study as well as open source implementations of the methods. + +## Requirements +- python3 +- nltk + ```python + import nltk + nltk.download('wordnet') + ``` + +## Acquiring The Data + +```bash +git clone https://github.com/yigitsever/Evaluating-Dictionary-Alignment.git && cd Evaluating-Dictionary-Alignment +./get_data.sh +``` + +This will create two directories; `dictionaries` and `wordnets`. +Linewise aligned definition files are in `wordnets/ready`. -- cgit v1.2.3-70-g09d2