I noticed that there was a mistake in the install step. In order to install deps, you would need to first clone the repository, as you otherwise would not have access to the requirements.txt file.
I therefore restructuring the installation instructions to follow a more natural flow and updated the corresponding text.
I am also used to the same installation steps being part of the CONTRIBUTING.md markdown, which I believe is quite standard. When making my initial PR, I failed to see that I needed to download the NER heuristic, which caused tests to fail. This could have been resolved by having these steps in the contrib markdown directly, as this is what I followed when making the PR.
I noticed that there was a mistake in the install step. In order to install deps, you would need to first clone the repository, as you otherwise would not have access to the
requirements.txtfile.I therefore restructuring the installation instructions to follow a more natural flow and updated the corresponding text.
I am also used to the same installation steps being part of the
CONTRIBUTING.mdmarkdown, which I believe is quite standard. When making my initial PR, I failed to see that I needed to download theNER heuristic, which caused tests to fail. This could have been resolved by having these steps in the contrib markdown directly, as this is what I followed when making the PR.