greek-inflexion icon indicating copy to clipboard operation
greek-inflexion copied to clipboard

documentation suggestion: basic instructions for getting it running

Open bcrowell opened this issue 2 years ago • 0 comments

This looks really nice -- thanks for making it open source!

I would suggest adding the following basic installation instructions to the README:

git clone https://github.com/jtauber/greek-inflexion pipenv install inflexion [... or something like pipenv --python /bin/python3 if that doesn't work] pipenv shell ./data_test.py exit

If I'm understanding correctly, then the inflexion and greek-accentuation libraries are automagically located and pulled in from git or something (although it's not obvious to me how it knows) -- it might be helpful to say this in the README, because from reading it, I was under the impression that I would have to go to some other repo and separately install these dependencies.

bcrowell avatar May 10 '22 15:05 bcrowell