search

glyph / Pomodouroboros

Pomodoro timer that acknowledges the inexorable, infinite passage of time
MIT License
191 stars 13 forks source link

basic documentation #23

Open glyph opened 3 years ago

glyph commented 3 years ago

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

m-aciek commented 3 years ago

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