diff --git a/README.md b/README.md index 894965a7..d025b9f1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,28 @@ git clone git@github.com:Allegheny-Ethical-CS/GatorMiner.git cd GatorMiner ``` -This program uses [Pipenv](https://github.com/pypa/pipenv) for dependency management. +This program uses [Pipenv](https://github.com/pypa/pipenv) for dependency management. +You can install these dependencies through running the provided scripts or by manually entering the commands. + +### Using Scripts + +Please read the Manual Commands section below for more information on the commands the scripts contain. + +To install using scripts, enter the following command that corresponds to your operating system into your terminal: + +#### Mac/Linux: + +``` +./scripts/install.sh +``` + +#### Windows: + +``` +.\scripts\install.bat +``` + +### Manual Commands - If needed, install and upgrade the `pipenv` with `pip`: diff --git a/scripts/install.bat b/scripts/install.bat new file mode 100644 index 00000000..3d3b759e --- /dev/null +++ b/scripts/install.bat @@ -0,0 +1,5 @@ + + +pipenv install +pipenv run python -m spacy download en_core_web_sm +pipenv run python -m spacy download en_core_web_md diff --git a/scripts/install.sh b/scripts/install.sh new file mode 100755 index 00000000..b23c7eae --- /dev/null +++ b/scripts/install.sh @@ -0,0 +1,17 @@ +#!/bin/bash +if [ -f "$(eval 'which pip')" ] +then + pip_version="pip" +elif [ -f "$(eval 'which pip3')" ] +then + pip_version="pip3" +else + $(eval "python3 -m pip install --upgrade pip") + pip_version="pip" +fi + +echo $(eval "$pip_version install pipenv -U") +echo $(eval "cd ..") +echo $(eval "pipenv install") +echo $(eval "pipenv run python -m spacy download en_core_web_sm") +echo $(eval "pipenv run python -m spacy download en_core_web_md")