about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorJames Booth <jamesbooth2000@hotmail.com>2012-06-19 02:02:21 +0200
committerJames Booth <jamesbooth2000@hotmail.com>2012-06-19 02:02:21 +0200
commit81901ebdabd711dd96c422425bd05235a04dd861 (patch)
treef29f418689280c50e2e373a78d4a7fdb8892e844 /README.md
parent4aff9f1cce3b45a8b6fb4c9aeb737d21bcab49c6 (diff)
downloadprofani-tty-81901ebdabd711dd96c422425bd05235a04dd861.tar.gz
Update master
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 13 insertions, 17 deletions
diff --git a/README.md b/README.md
index 87d783ae..ca5db988 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,16 @@
 Profanity
 =========
 
-Profanity is a console based jabber client inspired by Irssi,
+Profanity is a console based jabber client inspired by [Irssi](http://www.irssi.org/),
 
 Installation
 ------------
 
 Dependencies: ncurses, libstrophe, glib, expat, xml2 and openssl.
 
-Libstrophe can be found at:
+Libstrophe can be found at: https://github.com/metajack/libstrophe
 
-    https://github.com/metajack/libstrophe
-
-To run unit tests requires head-unit:
-
-    https://github.com/boothj5/head-unit
+To run unit tests requires head-unit: https://github.com/boothj5/head-unit
 
 All other dependencies should have packages for your distribution.
 
@@ -30,7 +26,7 @@ Running
     ./profanity
 
 Some older jabber servers advertise SSL/TLS support but don't respond to the handshake,
-if you have trouble connecting, run with the -notls option:
+if you have trouble connecting, run with the `-notls` option:
 
     ./profanity -notls
 
@@ -62,26 +58,26 @@ The following example is described below:
     bar_draw=black
     bar_text=black
 
-The [ui] section contains preferences for user interface behaviour:
+The `[ui]` section contains preferences for user interface behaviour:
 
-    beep:       Try to sound beep on incomming messages if the terminal supports it
-    flash:      Try to make the terminal flash on incomming messages if the terminal supports it
+    beep:       Try to sound beep on incoming messages if the terminal supports it
+    flash:      Try to make the terminal flash on incoming messages if the terminal supports it
     showsplash: Show the ascii logo on startup
 
-The [connections] section contains a history of logins you've used already, so profanity can autocomplete them for you.
-This section is populated automatically when you login with new usernames.
+The `[connections]` section contains a history of logins you've used already, so profanity can autocomplete them for you.
+This section is populated automatically when you login with a new username.
 
-The [colours] sections allows you to theme profanity.  Available colours are
+The `[colours]` sections allows you to theme profanity.  Available colours are
 
     black, white, red, green, blue, yellow, cyan, magenta
 
-Setting a colour to default, lets the terminal use whatever default it would use for foreground/background depending on the setting.
+Setting a colour to `default`, lets the terminal use whatever default it would use for foreground/background depending on the setting.
 
 Using
 -----
 
-Commands in profanity all start with '/'.
+Commands in profanity all start with `/`.
 
-To get a list of possible commands, and find our how to navigate around try:
+To get a list of possible commands, and find out how to navigate around try:
 
     /help