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

update readme

This commit is contained in:
Kevin Schoon 2018-01-31 08:12:09 -05:00
parent 7bffb5fe7e
commit 7f0df49878
2 changed files with 10 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -16,18 +16,13 @@ The Pomodoro Technique is simple and effective:
## Installation ## Installation
### 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
Binaries are available in the [releases section](https://github.com/kevinschoon/pomo/releases) on github. Binaries are available in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
``` ```
curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.2.0/pomo-0.2.0-linux curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.3.0/pomo-0.3.0-linux
echo f74156fdcdaec9574d64891b8fc76b7e5b0b2c00a446eb58e0fe4341fc83e9ad pomo | sha256sum -c - echo 2fb16d362d6ffef582fe5e8691272d93b021d14f32cbeda6895f0bb94d413903 pomo | sha256sum -c -
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -37,9 +32,7 @@ chmod +x pomo
``` ```
go get github.com/kevinschoon/pomo go get github.com/kevinschoon/pomo
cd $GOPATH/github.com/kevinschoon/pomo pomo -v
make
./bin/pomo
``` ```
## Usage ## Usage
@ -57,8 +50,8 @@ pomo start -t my-project "write some codes"
## Roadmap ## Roadmap
* Generate charts * Generate charts/burn down
* Notifiers for OSX and Windows(?) * System tray notification/icon
* ?? * ??
## Credits ## Credits

16
docs/index.html
View File

@ -142,16 +142,12 @@
<h2 id="installation">Installation</h2> <h2 id="installation">Installation</h2>
<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> <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> <p>Binaries are available in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
<pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.2.0/pomo-0.2.0-linux <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.3.0/pomo-0.3.0-linux
echo f74156fdcdaec9574d64891b8fc76b7e5b0b2c00a446eb58e0fe4341fc83e9ad pomo | sha256sum -c - echo 2fb16d362d6ffef582fe5e8691272d93b021d14f32cbeda6895f0bb94d413903 pomo | sha256sum -c -
chmod +x pomo chmod +x pomo
./pomo -v ./pomo -v
# Copy pomo to somewhere on your $PATH # Copy pomo to somewhere on your $PATH
@ -160,9 +156,7 @@ chmod +x pomo
<h3 id="source">Source</h3> <h3 id="source">Source</h3>
<pre><code> go get github.com/kevinschoon/pomo <pre><code> go get github.com/kevinschoon/pomo
cd $GOPATH/github.com/kevinschoon/pomo pomo -v
make
./bin/pomo
</code></pre> </code></pre>
<h2 id="usage">Usage</h2> <h2 id="usage">Usage</h2>
@ -180,8 +174,8 @@ chmod +x pomo
<h2 id="roadmap">Roadmap</h2> <h2 id="roadmap">Roadmap</h2>
<ul> <ul>
<li>Generate charts</li> <li>Generate charts/burn down</li>
<li>Notifiers for OSX and Windows(?)</li> <li>System tray notification/icon</li>
<li>??</li> <li>??</li>
</ul> </ul>