add docs

6 years ago · 1d74a3356d
parent 7b1bf2980c
commit 1d74a3356d
7 changed files with 448 additions and 2 deletions
--- a/10
+++ b/10
@ -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()}))' > $@
--- a/docs/404.html
+++ b/docs/404.html
@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<html lang="en-us">
+    <head>
+         
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>404 Page not found</title>
+        <style>
+
+    html body {
+        font-family: 'Raleway', sans-serif;
+        background-color: white;
+    }
+
+    :root {
+        --accent: red;
+        --border-width:  5px ;
+    }
+
+</style>
+
+
+<link rel="stylesheet" href="/pomo/css/main.css">
+
+
+
+
+
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway">
+
+
+ <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css"> 
+
+
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+
+
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
+ 
+
+
+    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+
+     <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/go.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/haskell.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/kotlin.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/scala.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/swift.min.js"></script> 
+
+    <script>hljs.initHighlightingOnLoad();</script>
+
+
+
+
+
+
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+
+
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+
+<script>$(document).on('click', function() { $('.collapse').collapse('hide'); })</script>
+ <meta name="generator" content="Hugo 0.19" />
+        
+        <link href="pomo/404.html/index.xml" rel="alternate" type="application/rss+xml" title="Pomo" />
+        <link href="pomo/404.html/index.xml" rel="feed" type="application/rss+xml" title="Pomo" />
+        
+        
+        
+    </head>
+
+    
+    <script type="text/javascript" async
+      src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  </script>
+
+    <body>
+         
+        <nav class="navbar navbar-default navbar-fixed-top">
+
+            <div class="container">
+
+                <div class="navbar-header">
+
+                    <a class="navbar-brand visible-xs" href="#">404 Page not found</a>
+
+                    <button class="navbar-toggle" data-target=".navbar-collapse" data-toggle="collapse">
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                    </button>
+
+                </div>
+
+                <div class="collapse navbar-collapse">
+
+                    
+
+                    
+
+                </div>
+
+            </div>
+
+        </nav>
+
+
+<main>
+
+    <div class="intro">
+
+        <h1>¯\_(ツ)_/¯</h1>
+
+        <h2>Page not found</h2>
+
+    </div>
+
+</main>
+
+        <footer>
+
+            <p class="copyright text-muted">&copy; All rights reserved. Powered by <a href="https://gohugo.io">Hugo</a> and <a href="https://github.com/calintat/minimal">Minimal</a></p>
+
+        </footer>
+       
+    </body>
+
+</html>
+
--- a/docs/css/main.css
+++ 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%;
+}
--- a/docs/index.html
+++ b/docs/index.html
@ -0,0 +1,183 @@
+<!DOCTYPE html>
+<html lang="en-us">
+    <head>
+         
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>Pomo</title>
+        <style>
+
+    html body {
+        font-family: 'Raleway', sans-serif;
+        background-color: white;
+    }
+
+    :root {
+        --accent: red;
+        --border-width:  5px ;
+    }
+
+</style>
+
+
+<link rel="stylesheet" href="/pomo/css/main.css">
+
+
+
+
+
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway">
+
+
+ <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css"> 
+
+
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+
+
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
+ 
+
+
+    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+
+     <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/go.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/haskell.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/kotlin.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/scala.min.js"></script>  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/swift.min.js"></script> 
+
+    <script>hljs.initHighlightingOnLoad();</script>
+
+
+
+
+
+
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+
+
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+
+<script>$(document).on('click', function() { $('.collapse').collapse('hide'); })</script>
+ <meta name="generator" content="Hugo 0.19" />
+        
+        <link href="pomo/index.xml" rel="alternate" type="application/rss+xml" title="Pomo" />
+        <link href="pomo/index.xml" rel="feed" type="application/rss+xml" title="Pomo" />
+        
+        
+        
+    </head>
+
+    
+    <script type="text/javascript" async
+      src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  </script>
+
+    <body>
+         
+        <nav class="navbar navbar-default navbar-fixed-top">
+
+            <div class="container">
+
+                <div class="navbar-header">
+
+                    <a class="navbar-brand visible-xs" href="#">Pomo</a>
+
+                    <button class="navbar-toggle" data-target=".navbar-collapse" data-toggle="collapse">
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                    </button>
+
+                </div>
+
+                <div class="collapse navbar-collapse">
+
+                    
+
+                    
+
+                </div>
+
+            </div>
+
+        </nav>
+
+
+<main>
+
+    <div class="intro">
+
+         <img class="profile" src="/tomato.png"> 
+
+        <h1>Pomo</h1>
+
+        <h2>Pomodoro Command Line Interface</h2>
+
+        <div class="btn-group" role="group" aria-label="...">
+            <button type="button" class="btn btn-default">
+                <a href="https://github.com/kevinschoon/pomo">install pomo</a>
+            </button>
+        </div>
+
+
+    </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>
+
+<h2 id="background">Background</h2>
+
+<p>The Pomodoro Technique is simple and effective time management technique:</p>
+
+<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>
+
+<h3 id="binaries">Binaries</h3>
+
+<p>Check out the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> for the latest binrary.</p>
+
+<h3 id="source">Source</h3>
+
+<pre><code> go get github.com/kevinschoon/pomo
+ cd $GOPATH/github.com/kevinschoon/pomo
+ make
+ ./bin/pomo
+</code></pre>
+
+<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
+...
+</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>
+<li>Support OSX</li>
+<li>Support Windows</li>
+<li>Generate charts</li>
+<li>Alternate notifiers</li>
+<li>??</li>
+</ul>
+
+    </div>
+
+</main>
--- a/docs/index.xml
+++ b/docs/index.xml
@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>Pomo</title>
+    <link>/pomo/index.xml</link>
+    <description>Recent content on Pomo</description>
+    <generator>Hugo -- gohugo.io</generator>
+    <language>en-us</language>
+    <atom:link href="/pomo/index.xml" rel="self" type="application/rss+xml" />
+    
+  </channel>
+</rss>
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  
+  <url>
+    <loc>/pomo/</loc>
+    <priority>0</priority>
+  </url>
+  
+</urlset>
--- a/docs/tomato.png
+++ b/docs/tomato.png