Browse Source

Add requirements and update README

luozhouyang 7 years ago
parent
commit
1d5465a905
3 changed files with 10 additions and 0 deletions
  1. 1 0
      .gitignore
  2. 8 0
      README.md
  3. 1 0
      requirements.txt

+ 1 - 0
.gitignore

@@ -2,3 +2,4 @@
 .vscode/
 __pycache__/
 similarity/__pycache__/
+venv/

+ 8 - 0
README.md

@@ -27,6 +27,14 @@ A library implementing different string similarity and distance measures. A doze
 * [Users](#users)
 
 
+## Download
+
+```bash
+git clone https://github.com/luozhouyang/python-string-similarity
+cd python-string-similarity
+pip install -r requirements.txt
+```
+
 ## Overview
 
 The main characteristics of each implemented algorithm are presented below. The "cost" column gives an estimation of the computational cost to compute the similarity between two strings of length m and n respectively.

+ 1 - 0
requirements.txt

@@ -0,0 +1 @@
+numpy