2018-01-22 16:07:58 +01:00
<!DOCTYPE html>
2021-07-29 01:50:26 +02:00
< html >
< head >
< meta name = "generator" content = "Hugo 0.85.0" / >
< meta charset = "utf-8" >
< title > Pomo
< / title >
2021-07-29 01:52:48 +02:00
< link rel = "stylesheet" href = "/pomo/css/main.css" >
< link rel = "stylesheet" href = "/pomo/css/pure.css" >
2021-07-29 01:50:26 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< / head >
< body >
2018-01-22 16:07:58 +01:00
2021-07-29 01:50:26 +02:00
< div class = "content" >
2018-01-22 16:07:58 +01:00
< main >
< div class = "intro" >
2021-07-29 01:52:48 +02:00
< a href = "https://github.com/kevinschoon/pomo" > < img class = "tomato" src = "/pomo/tomato.png" / > < / a >
2021-07-29 01:50:26 +02:00
< h1 > Pomo < / h1 >
< h1 > Pomodoro Command Line Interface < / h1 >
2021-07-29 01:52:48 +02:00
< img class = "demo" src = "/pomo/demo.gif" / >
2018-01-22 16:07:58 +01:00
< / div >
< div class = "readme" >
2021-07-29 01:50:26 +02:00
<!-- raw HTML omitted -->
< h1 id = "-pomo" > 🍅 pomo< / h1 >
< p > < img src = "https://github.com/kevinschoon/pomo/workflows/pomo/badge.svg" alt = "pomo" > < / p >
2019-02-10 20:53:26 +01:00
< p > < code > pomo< / code > is a simple CLI for using the < a href = "https://en.wikipedia.org/wiki/Pomodoro_Technique" > Pomodoro Technique< / a > . There are < a href = "https://taskwarrior.org/" > some< / a > < a href = "https://todoist.com/" > amazing< / a > task management systems but < code > pomo< / code > is more of a task < em > execution< / em > or < a href = "https://en.wikipedia.org/wiki/Timeboxing" > timeboxing< / a > system. < code > pomo< / code > helps you track what you did, how long it took you to do it, and how much effort you expect it to take.< / p >
2018-01-22 16:07:58 +01:00
< h2 id = "background" > Background< / h2 >
2018-01-22 17:28:13 +01:00
< p > The Pomodoro Technique is simple and effective:< / p >
2018-01-22 16:07:58 +01:00
< ul >
< li > Decide on a task you want to accomplish< / li >
< li > Break the task into timed intervals (pomodoros), [approx. 25 min]< / li >
< li > After each pomodoro take a short break [approx. 3 - 5 min]< / li >
< li > Once all pomodoros are completed take a longer break [approx 15 - 20 min]< / li >
< li > Repeat< / li >
< / ul >
< h2 id = "installation" > Installation< / h2 >
2021-07-29 02:03:23 +02:00
< h3 id = "source" > Source< / h3 >
< div class = "highlight" > < pre style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4" > < code class = "language-bash" data-lang = "bash" > git clone git@github.com:kevinschoon/pomo.git
cd pomo
make
2021-07-29 01:50:26 +02:00
< / code > < / pre > < / div > < h2 id = "usage" > Usage< / h2 >
2018-01-30 04:18:27 +01:00
< p > Once < code > pomo< / code > is installed you need to initialize it’ s database.< / p >
2021-07-29 01:50:26 +02:00
< div class = "highlight" > < pre style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4" > < code class = "language-bash" data-lang = "bash" > pomo init
< / code > < / pre > < / div > < p > Start a 4 pomodoro session at 25 minute intervals:< / p >
< div class = "highlight" > < pre style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4" > < code class = "language-bash" data-lang = "bash" > pomo start -t my-project < span style = "color:#e6db74" > " write some codes" < / span >
< / code > < / pre > < / div > < h2 id = "configuration" > Configuration< / h2 >
2018-02-03 19:50:03 +01:00
< p > Pomo has a few configuration options which can be read from a JSON file in Pomo’ s state directory < code > ~/.pomo/config.json< / code > .< / p >
< h3 id = "colors" > colors< / h3 >
< p > You can map colors to specific tags in the < code > colors< / code > field.< / p >
< p > Example:< / p >
2021-07-29 01:50:26 +02:00
< div class = "highlight" > < pre style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4" > < code class = "language-json" data-lang = "json" > {
< span style = "color:#f92672" > " colors" < / span > : {
< span style = "color:#f92672" > " my-project" < / span > : < span style = "color:#e6db74" > " hiyellow" < / span > ,
< span style = "color:#f92672" > " another-project" < / span > : < span style = "color:#e6db74" > " green" < / span >
2018-02-03 19:50:03 +01:00
}
}
2021-07-29 01:50:26 +02:00
< / code > < / pre > < / div > < h2 id = "integrations" > Integrations< / h2 >
2018-02-04 04:30:57 +01:00
< h3 id = "status-bars" > Status Bars< / h3 >
< p > The Pomo CLI can output the current state of a running task session via the < code > pomo status< / code >
making it easy to script and embed it’ s output in various Linux status bars.< / p >
2021-07-29 01:50:26 +02:00
< h4 id = "polybarhttpsgithubcomjaagrpolybar" > < a href = "https://github.com/jaagr/polybar" > Polybar< / a > < / h4 >
2018-02-04 04:30:57 +01:00
< p > You can create a module with the < code > custom/script< / code > type and
embed Pomo’ s status output in your Polybar:< / p >
2021-07-29 01:50:26 +02:00
< div class = "highlight" > < pre style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4" > < code class = "language-ini" data-lang = "ini" > < span style = "color:#66d9ef" > [module/pomo]< / span >
< span style = "color:#a6e22e" > type< / span > < span style = "color:#f92672" > =< / span > < span style = "color:#e6db74" > custom/script< / span >
< span style = "color:#a6e22e" > interval< / span > < span style = "color:#f92672" > =< / span > < span style = "color:#e6db74" > 1< / span >
< span style = "color:#a6e22e" > exec< / span > < span style = "color:#f92672" > =< / span > < span style = "color:#e6db74" > pomo status< / span >
< / code > < / pre > < / div > < h2 id = "roadmap" > Roadmap< / h2 >
2018-01-22 16:07:58 +01:00
< ul >
2018-01-31 14:12:09 +01:00
< li > Generate charts/burn down< / li >
2018-01-22 16:07:58 +01:00
< li > ??< / li >
2018-01-22 17:34:18 +01:00
< / ul >
< h2 id = "credits" > Credits< / h2 >
< ul >
< li > < a href = "https://cirillocompany.de/pages/pomodoro-technique/book/" > pomodoro technique< / a > < / li >
< li > < a href = "https://openclipart.org/detail/262421/tomato-by-rones" > logo by rones< / a > < / li >
< li > < a href = "http://gohugo.io/" > website generate by hugo< / a > < / li >
< li > < a href = "https://github.com/calintat/minimal" > theme by calintat< / a > < / li >
2018-01-22 16:07:58 +01:00
< / ul >
< / div >
< / main >
2021-07-29 01:50:26 +02:00
< / div > < div id = "footer" >
< small >
2021
< / small >
< / div >
< / body >
< / html >
