aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 35 insertions, 8 deletions
diff --git a/README.md b/README.md
index 803dc74..11d7fe1 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,49 @@
-gstopwatch
-----------
+Gstopwatch
+=========
+
+**A simple stopwatch, written in GTK3.**
+
Okay, so apparently there are absolutely zero good stopwatches around for X11!
I spent my time searching but couldn't find one simple enough for me. This
stopwatch will start counting, stop counting and reset.
Usage
-----
-Press space to start timing, space to stop, space again to reset and start
-timing again.
+The spacebar does it all! Press space to start timing, space to stop, space again to reset and space to start timing again.
+
+Installation
+------------
+
+You'll need the GTK 3.x libraries and headers installed and ready to go. To
+build, simply run these commands:
+
+ $ make
+ $ make clean install
+
+Bugs
+----
+
+For any bug or request [fill an issue][bug] on [GitHub][ghp].
-Building
---------
-You'll need the gtk 3.x libraries and headers installed and ready to go. To
-build, simple run make in the gstopwatch folder
+ [bug]: https://github.com/Unia/gstopwatch/issues
+ [ghp]: https://github.com/Unia/gstopwatch
ToDo
----
+
+* Centralize text, display them like gnome-clocks?
* Laps
* Hours:Minutes:Seconds display
* Font size
+
+License
+-------
+
+**Gstopwatch** is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+**Gstopwatch** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+**Copyright © 2013** Jente (jthidskes at outlook dot com)