Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation suggestion: basic instructions for getting it running #37

Open
bcrowell opened this issue May 10, 2022 · 0 comments
Open

Comments

@bcrowell
Copy link

bcrowell commented May 10, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant