diff --git a/Makefile b/Makefile index 1a9f339..2afe7b5 100644 --- a/Makefile +++ b/Makefile @@ -5,12 +5,15 @@ endif .PHONY: \ all \ - test + test \ + docs \ + readme all: bin/pomo clean: rm -v bin/* 2> /dev/null || true + rm -v docs/* 2> /dev/null || true bindata.go: go-bindata -pkg main -o $@ tomato-icon.png @@ -22,5 +25,8 @@ bin/pomo: bindata.go @echo mkdir bin 2>/dev/null || true go build -ldflags "-X main.Version=$(VERSION)" -o bin/pomo -www/data/readme.json: +docs: www/data/readme.json + cd www && hugo -d ../docs + +readme: cat README.md | python -c 'import json,sys; print(json.dumps({"content": sys.stdin.read()}))' > $@ diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..240688d --- /dev/null +++ b/docs/404.html @@ -0,0 +1,127 @@ + + + + + + + 404 Page not found + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +

¯\_(ツ)_/¯

+ +

Page not found

+ +
+ +
+ + + + + + + diff --git a/docs/css/main.css b/docs/css/main.css new file mode 100644 index 0000000..fea7746 --- /dev/null +++ b/docs/css/main.css @@ -0,0 +1,109 @@ +html, +body { + height: 100%; +} + +body { + padding-top: 55px; + display: flex; + text-align: center; + flex-direction: column; +} + +main { + margin: auto; + padding: 25px; + flex: 1 0 auto; + max-width: 750px; +} + +/*footer*/ + +.copyright { + margin: 15px 0; +} + +/*home page*/ + +/* +.intro { + transform: translateY(22vh); +} +*/ + +.intro>h1 { + color: #212121; + font-size: 12vh; +} + +.intro>h2 { + color: #757575; + font-size: 3vmin; +} + +.intro>.profile { + width: 10vh; + height: 10vh; + border-radius: 50%; +} + +div.readme { + text-align: left !important; + padding-top: 100px; +} + +/*apply accent colour to links*/ + +a:link, +a:visited { + color: var(--accent); +} + +a.icon:hover { + text-decoration: none; +} + +a:hover { + color: var(--accent) !important; +} + +/*paginator at bottom of list view*/ + +.pages { + padding: 15px 0; +} + +.pages-icon { + padding: 0 15px; +} + +/*list item for posts and projects*/ + +.item { + padding: 10px 0; +} + +.item-tag { + background-color: var(--accent); +} + +/*navigation bar icons*/ + +.navbar-icon { + font-size: 125%; + display: inline-block !important; +} + +/*coloured borders at top and bottom of the page*/ + +.navbar.navbar-default { + border-top: var(--border-width) solid var(--accent); +} + +footer { + border-bottom: var(--border-width) solid var(--accent); +} + +img { + max-width: 100%; +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..69c805c --- /dev/null +++ b/docs/index.html @@ -0,0 +1,183 @@ + + + + + + + Pomo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +

Pomo

+ +

Pomodoro Command Line Interface

+ +
+ +
+ + +
+ +
+ pomo is a simple CLI implementation of the Pomodoro Technique. It was written for use on a Linux desktop but can easily be ported over to other platforms.

+ +

Background

+ +

The Pomodoro Technique is simple and effective time management technique:

+ + + +

Installation

+ +

Binaries

+ +

Check out the releases section for the latest binrary.

+ +

Source

+ +
 go get github.com/kevinschoon/pomo
+ cd $GOPATH/github.com/kevinschoon/pomo
+ make
+ ./bin/pomo
+
+ +

Usage

+ +
# 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
+...
+
+ +

Dependencies

+ +

pomo depends on the libnotify client package, a notification server (installed with most Linux desktop environments), and SQLite.

+ +

Roadmap

+ + + +
+ +
diff --git a/docs/index.xml b/docs/index.xml new file mode 100644 index 0000000..82cd571 --- /dev/null +++ b/docs/index.xml @@ -0,0 +1,12 @@ + + + + Pomo + /pomo/index.xml + Recent content on Pomo + Hugo -- gohugo.io + en-us + + + + \ No newline at end of file diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..f3ff3e5 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,9 @@ + + + + + /pomo/ + 0 + + + \ No newline at end of file diff --git a/docs/tomato.png b/docs/tomato.png new file mode 100644 index 0000000..1908645 Binary files /dev/null and b/docs/tomato.png differ