From 5bce4d046c03397c1479e9d0818a780ca813c7ed Mon Sep 17 00:00:00 2001 From: Diego Rubin Date: Sat, 14 Mar 2015 15:55:05 -0300 Subject: [PATCH] Writing README file and closes #2. --- README | 4 +--- README.md | 31 +++++++++++++++++++++++++++++-- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/README b/README index b3a409f..4ad2e70 100644 --- a/README +++ b/README @@ -1,4 +1,2 @@ - Gnomato - - Email: rubin.diego at gmail.com +See the README.md file. diff --git a/README.md b/README.md index f9537a0..9efc444 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,37 @@ #Gnomato -##Install +Pomodoro Tracker for GNU/Linux. +##Requirements + +* Gtkmm 3.0 +* Libnotify +* Python 2.7 +* Sqlite3 + +##Installing + +Download the stable tarball [1.0.1](https://github.com/diegorubin/gnomato/releases/download/1.0.1/gnomato-1.0.1.tar.gz) + + tar -zxvf gnomato-1.0.1.tar.gz + cd gnomato-1.0.1 ./configure make sudo make install -##Contributing +##Building + +To build the project you need to have installed all development libraries +of the projects listed in Requirements. + +In addition you must have installed the autotools and gettext. + +To generate `configure` script and `Makefiles` execute: + + autoreconf -vi + +##Contacting + +To report bugs send email to rubin.diego[at]gmail.com or +create issues in this github repository.