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

basic documentation #23

Open
glyph opened this issue Aug 26, 2021 · 1 comment
Open

basic documentation #23

glyph opened this issue Aug 26, 2021 · 1 comment
Labels
maintainability refactoring, internal documentation, and other things that keep the code maintainable
Milestone

Comments

@glyph
Copy link
Owner

glyph commented Aug 26, 2021

this thing is an inscrutable mess now, until the UI improves at least have an explanation of how to use it

@m-aciek
Copy link

m-aciek commented Aug 30, 2021

I didn't find a better place to leave my feedback, but I think this potentially is a good candidate for Installation section in docs. For anyone encountering an issue running the project: you have to run ./runme script in a virtualenv basing on system Python.

This is how to do it with pyenv (assuming you have pyenv already installed):

% python3 -m venv ~/.pyenv/versions/pomodouroboros
% pyenv local pomodouroboros
% pip install -r requirements.txt
% ./runme

@glyph glyph added this to the 1.0 milestone Jan 13, 2024
@glyph glyph added the maintainability refactoring, internal documentation, and other things that keep the code maintainable label Jan 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintainability refactoring, internal documentation, and other things that keep the code maintainable
Projects
None yet
Development

No branches or pull requests

2 participants