INSTALL.md and requirements.txt

INSTALL.md

+# Installation instructions
+
+In order to make use of this library, install it as follows:
+
+1. Clone this repository: git clone https://gitlab.ujaen.es/jcollado/textflow.git 
+
+2. Use this inside the project's folder: python -m pip install .
+
+This library has been tested in Python 3.8+

README.md

@@ -8,9 +8,9 @@ This class provides methods to create a sequence from directories, documents, st
 
 ### ./textFlow
 
-- ** [Analyzer.py](https://gitlab.ujaen.es/jcollado/textflow/blob/master/textflow/Analyzer.py):** This module provides an abstract class with methods for the calculation of different metrics on a sequence.
+- **[Analyzer.py](https://gitlab.ujaen.es/jcollado/textflow/blob/master/textflow/Analyzer.py):** This module provides an abstract class with methods for the calculation of different metrics on a sequence.
 
-- ** [ComplexityAnalyzer.py](https://gitlab.ujaen.es/jcollado/textflow/blob/master/textflow/ComplexityAnalyzer.py):** This module provides a class methods for the calculation of different complexity metrics on a sequence. This class inherits from Analyzer.py
+- **[ComplexityAnalyzer.py](https://gitlab.ujaen.es/jcollado/textflow/blob/master/textflow/ComplexityAnalyzer.py):** This module provides a class methods for the calculation of different complexity metrics on a sequence. This class inherits from Analyzer.py
 
 - **[CREA_5000.txt](https://gitlab.ujaen.es/jcollado/textflow/blob/master/textflow/Crea-5000.txt):** A dataset of 5000 spanish words ordered by its absolute frequency.
 
@@ -40,9 +40,9 @@ This class provides methods to create a sequence from directories, documents, st
 
 ### ./examples
 
-- **example_text.txt:** Simple .txt file to test the library.
+- **[example_text.txt](https://gitlab.ujaen.es/jcollado/textflow/blob/master/Examples/ExampleDirectory/Documento%20sin%20t%C3%ADtulo.txt):** Simple .txt file to test the library.
 
-- **example.ipynb:** Colab notebook that shows how to use the different methods of textFlow.
+- **[example.ipynb](https://gitlab.ujaen.es/jcollado/textflow/blob/master/Examples/Example.ipynb):** Colab notebook that shows how to use the different methods of textFlow.
 
 # Metrics
 

requirements.txt

+blis==0.7.7; python_version >= "3.6"
+catalogue==2.0.7; python_version >= "3.6"
+certifi==2022.5.18.1; python_full_version >= "3.7.0" and python_version >= "3.6"
+charset-normalizer==2.0.12; python_full_version >= "3.7.0" and python_version >= "3.6"
+click==8.1.3; python_version >= "3.7"
+colorama==0.4.4; platform_system == "Windows" and python_version >= "3.7" and python_full_version >= "3.7.0"
+cymem==2.0.6; python_version >= "3.6"
+filelock==3.7.0; python_version >= "3.7" and python_full_version >= "3.7.0"
+huggingface-hub==0.6.0; python_full_version >= "3.7.0"
+idna==3.3; python_full_version >= "3.7.0" and python_version >= "3.6"
+jinja2==3.1.2; python_version >= "3.7"
+joblib==1.1.0; python_version >= "3.7"
+langcodes==3.3.0; python_version >= "3.6"
+markupsafe==2.1.1; python_version >= "3.7"
+murmurhash==1.0.7; python_version >= "3.6"
+nltk==3.7; python_version >= "3.7"
+numpy==1.22.4; python_version >= "3.8" and python_full_version >= "3.7.0"
+packaging==21.3; python_version >= "3.6" and python_full_version >= "3.7.0"
+pathy==0.6.1; python_version >= "3.6"
+preshed==3.0.6; python_version >= "3.6"
+pydantic==1.8.2; python_full_version >= "3.6.1" and python_version >= "3.6"
+pyparsing==3.0.9; python_version >= "3.6" and python_full_version >= "3.7.0"
+pyyaml==6.0; python_version >= "3.6" and python_full_version >= "3.7.0"
+regex==2022.4.24; python_version >= "3.7" and python_full_version >= "3.7.0"
+requests==2.27.1; python_full_version >= "3.7.0" and python_version >= "3.6"
+smart-open==5.2.1; python_version >= "3.6" and python_version < "4.0"
+spacy-legacy==3.0.9; python_version >= "3.6"
+spacy-loggers==1.0.2; python_version >= "3.6"
+spacy==3.3.0; python_version >= "3.6"
+srsly==2.4.3; python_version >= "3.6"
+thinc==8.0.16; python_version >= "3.6"
+tokenizers==0.12.1; python_full_version >= "3.7.0"
+torch==1.11.0; python_version >= "3.7" and python_version < "4.0" and sys_platform == "linux"
+tqdm==4.64.0; python_full_version >= "3.7.0" and python_version >= "3.7"
+transformers==4.19.2; python_full_version >= "3.7.0"
+typer==0.4.1; python_version >= "3.6"
+typing-extensions==4.2.0; python_version >= "3.7" and python_version < "4.0" and sys_platform == "linux" and python_full_version >= "3.7.0"
+urllib3==1.26.9; python_full_version >= "3.7.0" and python_version < "4" and python_version >= "3.6"
+wasabi==0.9.1; python_version >= "3.6"