update docs
This commit is contained in:
Kevin Schoon
parent
d02072888d
commit
857a539790
26
README.md
26
README.md
|
|
@ -1,10 +1,10 @@
|
|||
# 🍅 pomo
|
||||
|
||||
`pomo` is a simple CLI implementation of the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). It was written for use on a Linux desktop but can easily be ported over to other platforms.
|
||||
`pomo` is a simple CLI for using the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). There are [some](https://taskwarrior.org/) [amazing](https://todoist.com/) task management systems but `pomo` is more of a task *execution* or [timeboxing](https://en.wikipedia.org/wiki/Timeboxing) system. `pomo` helps you track what you did, how long it took you do it, and how long you expect it will take.
|
||||
|
||||
## Background
|
||||
|
||||
The Pomodoro Technique is simple and effective time management technique:
|
||||
The Pomodoro Technique is simple and effective:
|
||||
|
||||
* Decide on a task you want to accomplish
|
||||
* Break the task into timed intervals (pomodoros), [approx. 25 min]
|
||||
|
|
@ -14,11 +14,23 @@ The Pomodoro Technique is simple and effective time management technique:
|
|||
|
||||
## Installation
|
||||
|
||||
### Binaries
|
||||
`pomo` depends on the [libnotify](https://developer.gnome.org/libnotify/) client package, a notification [server](https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers) (installed with most Linux desktop environments), and [SQLite](https://sqlite.org/).
|
||||
|
||||
Check out the [releases section](https://github.com/kevinschoon/pomo/releases) for the latest binrary.
|
||||
Binaries are available in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
|
||||
|
||||
### Source
|
||||
### Linux
|
||||
|
||||
#### Binaries
|
||||
|
||||
```
|
||||
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.1.0/pomo-0.1.0-linux
|
||||
echo f4587b566d135e05a6c1b1bec50fe3378f643f654319ca4662d5fe3aa590b8d2 pomo | sha256sum -c -
|
||||
chmod +x pomo
|
||||
./pomo -v
|
||||
# Copy pomo to somewhere on your $PATH
|
||||
```
|
||||
|
||||
#### Source
|
||||
|
||||
```
|
||||
go get github.com/kevinschoon/pomo
|
||||
|
|
@ -41,10 +53,6 @@ pomo start -t dev -p 2 -d 1m "Write Some Codes"
|
|||
...
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
`pomo` depends on the [libnotify](https://developer.gnome.org/libnotify/) client package, a notification [server](https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers) (installed with most Linux desktop environments), and [SQLite](https://sqlite.org/).
|
||||
|
||||
## Roadmap
|
||||
|
||||
* Support OSX
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ main {
|
|||
margin: auto;
|
||||
padding: 25px;
|
||||
flex: 1 0 auto;
|
||||
max-width: 750px;
|
||||
max-width: 1200px;
|
||||
}
|
||||
|
||||
/*footer*/
|
||||
|
|
|
|||
|
|
@ -123,11 +123,13 @@
|
|||
</div>
|
||||
|
||||
<div class="readme">
|
||||
<code>pomo</code> is a simple CLI implementation of the <a href="https://en.wikipedia.org/wiki/Pomodoro_Technique">Pomodoro Technique</a>. It was written for use on a Linux desktop but can easily be ported over to other platforms.</p>
|
||||
<h1 id="pomo">🍅 pomo</h1>
|
||||
|
||||
<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 do it, and how long you expect it will take.</p>
|
||||
|
||||
<h2 id="background">Background</h2>
|
||||
|
||||
<p>The Pomodoro Technique is simple and effective time management technique:</p>
|
||||
<p>The Pomodoro Technique is simple and effective:</p>
|
||||
|
||||
<ul>
|
||||
<li>Decide on a task you want to accomplish</li>
|
||||
|
|
@ -139,11 +141,22 @@
|
|||
|
||||
<h2 id="installation">Installation</h2>
|
||||
|
||||
<h3 id="binaries">Binaries</h3>
|
||||
<p><code>pomo</code> depends on the <a href="https://developer.gnome.org/libnotify/">libnotify</a> client package, a notification <a href="https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers">server</a> (installed with most Linux desktop environments), and <a href="https://sqlite.org/">SQLite</a>.</p>
|
||||
|
||||
<p>Check out the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> for the latest binrary.</p>
|
||||
<p>Binaries are available in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
|
||||
|
||||
<h3 id="source">Source</h3>
|
||||
<h3 id="linux">Linux</h3>
|
||||
|
||||
<h4 id="binaries">Binaries</h4>
|
||||
|
||||
<pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.1.0/pomo-0.1.0-linux
|
||||
echo f4587b566d135e05a6c1b1bec50fe3378f643f654319ca4662d5fe3aa590b8d2 pomo | sha256sum -c -
|
||||
chmod +x pomo
|
||||
./pomo -v
|
||||
# Copy pomo to somewhere on your $PATH
|
||||
</code></pre>
|
||||
|
||||
<h4 id="source">Source</h4>
|
||||
|
||||
<pre><code> go get github.com/kevinschoon/pomo
|
||||
cd $GOPATH/github.com/kevinschoon/pomo
|
||||
|
|
@ -164,10 +177,6 @@ pomo start -t dev -p 2 -d 1m "Write Some Codes"
|
|||
...
|
||||
</code></pre>
|
||||
|
||||
<h2 id="dependencies">Dependencies</h2>
|
||||
|
||||
<p><code>pomo</code> depends on the <a href="https://developer.gnome.org/libnotify/">libnotify</a> client package, a notification <a href="https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers">server</a> (installed with most Linux desktop environments), and <a href="https://sqlite.org/">SQLite</a>.</p>
|
||||
|
||||
<h2 id="roadmap">Roadmap</h2>
|
||||
|
||||
<ul>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ main {
|
|||
margin: auto;
|
||||
padding: 25px;
|
||||
flex: 1 0 auto;
|
||||
max-width: 750px;
|
||||
max-width: 1200px;
|
||||
}
|
||||
|
||||
/*footer*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue