NaiJi/kevinschoon-pomo
NaiJi
/
kevinschoon-pomo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

This commit is contained in:
Kevin Schoon 2018-01-29 22:18:27 -05:00
parent 969c9c2f98
commit 5cb9152c53
2 changed files with 37 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,3 +1,5 @@
<p align="center"><img src="https://raw.githubusercontent.com/kevinschoon/pomo/master/www/static/demo.gif" alt="demo"/></p>
# 🍅 pomo
`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 much effort you expect it to take.
@ -14,23 +16,24 @@ The Pomodoro Technique is simple and effective:
## Installation
`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/).
### Dependencies
`pomo` depends on the [SQLite](https://sqlite.org) runtime, make sure it is installed before continuing. If running on Linux `pomo` will attempt to send notifications via [libnotify](https://developer.gnome.org/libnotify).
### Binaries
Binaries are available in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
### 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 -
echo f74156fdcdaec9574d64891b8fc76b7e5b0b2c00a446eb58e0fe4341fc83e9ad pomo | sha256sum -c -
chmod +x pomo
./pomo -v
# Copy pomo to somewhere on your $PATH
```
#### Source
### Source
```
go get github.com/kevinschoon/pomo
@ -41,24 +44,21 @@ chmod +x pomo
## Usage
Once `pomo` is installed you need to initialize it's database.
```
# Initialize the SQLite database and state directory
pomo init
# Start a new task
# Add a tag "dev", allocate 2 pomodoros for 1 minute each
pomo start -t dev -p 2 -d 1m "Write Some Codes"
...
# List previous tasks
# pomo list
...
```
Start a 4 pomodoro session at 25 minute intervals:
```
pomo start -t my-project "write some codes"
```
## Roadmap
* Support OSX
* Support Windows
* Generate charts
* Alternate notifiers
* Notifiers for OSX and Windows(?)
* ??
## Credits

39
docs/index.html
View File

@ -123,7 +123,9 @@
</div>
<div class="readme">
<h1 id="pomo">🍅 pomo</h1>
<p align="center"><img src="https://raw.githubusercontent.com/kevinschoon/pomo/master/www/static/demo.gif" alt="demo"/></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 much effort you expect it to take.</p>
@ -141,22 +143,22 @@
<h2 id="installation">Installation</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>
<h3 id="dependencies">Dependencies</h3>
<p><code>pomo</code> depends on the <a href="https://sqlite.org">SQLite</a> runtime, make sure it is installed before continuing. If running on Linux <code>pomo</code> will attempt to send notifications via <a href="https://developer.gnome.org/libnotify">libnotify</a>.</p>
<h3 id="binaries">Binaries</h3>
<p>Binaries are available in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
<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 -
echo f74156fdcdaec9574d64891b8fc76b7e5b0b2c00a446eb58e0fe4341fc83e9ad pomo | sha256sum -c -
chmod +x pomo
./pomo -v
# Copy pomo to somewhere on your $PATH
</code></pre>
<h4 id="source">Source</h4>
<h3 id="source">Source</h3>
<pre><code> go get github.com/kevinschoon/pomo
cd $GOPATH/github.com/kevinschoon/pomo
@ -166,24 +168,21 @@ chmod +x pomo
<h2 id="usage">Usage</h2>
<pre><code># Initialize the SQLite database and state directory
pomo init
# Start a new task
# Add a tag &quot;dev&quot;, allocate 2 pomodoros for 1 minute each
pomo start -t dev -p 2 -d 1m &quot;Write Some Codes&quot;
...
# List previous tasks
# pomo list
...
<p>Once <code>pomo</code> is installed you need to initialize it&rsquo;s database.</p>
<pre><code>pomo init
</code></pre>
<p>Start a 4 pomodoro session at 25 minute intervals:</p>
<pre><code>pomo start -t my-project &quot;write some codes&quot;
</code></pre>
<h2 id="roadmap">Roadmap</h2>
<ul>
<li>Support OSX</li>
<li>Support Windows</li>
<li>Generate charts</li>
<li>Alternate notifiers</li>
<li>Notifiers for OSX and Windows(?)</li>
<li>??</li>
</ul>