From 93a84c7965d553bbfa2831ce690b62c8e2acbafb Mon Sep 17 00:00:00 2001 From: Jakob Nixdorf Date: Fri, 4 Mar 2016 07:34:48 +0100 Subject: [PATCH] Add some links to the README --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b35991f..108a7ea 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ ## Requirements -* glib2 -* GTK+ 3.0 -* VTE 2.91 -* cmake >= 3.0.0 +* [glib2](https://developer.gnome.org/glib/) +* [GTK+ 3](http://www.gtk.org/) +* [VTE 2.91](https://developer.gnome.org/vte/) +* [cmake](https://cmake.org/) >= 3.0.0 ## Installation @@ -34,12 +34,18 @@ Just run `sterm` after the build to start the terminal. `sterm --help` will give the basic options. The main configuration file should be placed at `${XDG_CONFIG_HOME}/sterm/sterm.ini` (with `${XDG_CONFIG_HOME}` usually being `${HOME}/.config`). +## Bugs + +Please report any bugs and feature requests on [GitHub](https://github.com/flocke/sterm/issues). +Pull requests with fixes and improvements are always welcome. + ## Rewrite -This is the rewrite of my first version of STerm, which can still be found in the `old-and-broken` -branch on GitHub. It has the same dependencies and should be mostly feature compatible with the old -version (including the config file syntax and options). That's why a update to this new version -should be possible without any problems. +This is the rewrite of my first version of STerm, which can still be found in the +[old-and-broken](https://github.com/flocke/sterm/tree/old-and-broken) branch on GitHub. It has the +same dependencies and should be mostly feature compatible with the old version (including the +config file syntax and options). That's why a update to this new version should be possible without +any problems. ## Copyright