From 99bb7ccf3196c7a7b0c3e9ff3989b2f5c2c7aae7 Mon Sep 17 00:00:00 2001 From: jeena Date: Wed, 24 Apr 2013 16:40:25 +0200 Subject: [PATCH] readme fixes --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e14ed8c..1a0daad 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -= Feed the Monkey +# Feed the Monkey Feed the Monkey is a desktop client for [TinyTinyRSS](http://tt-rss.org). That means that it doesn't work as a standalone feed reader but only as a client for the TinyTinyRSS API which it uses to get the normalized feeds and to synchronize the "article read" marks. It is written in PyQt and uses Webkit to show the contents. -== Installation +## Installation You need to have PyQt installed and a account on a TinyTinyRSS instance. @@ -12,20 +12,20 @@ Download the [ZIP](https://github.com/jeena/feedthemonkey/archive/master.zip)-fi `sudo python setup.py install` -== Keyboard shortcuts +## Keyboard shortcuts The keyboard shortcuts are inspired by other feed readers which are inspired by the text editor vi. -`j` or `→` show nex article -`k` or `←` show previous article -`n` or `Return` open current article in the default browser -`r` reload articles -`Ctrl Q` quit -`Ctrl +` zoom in -`Ctrl -` zoom out +`j` or `→` show nex article +`k` or `←` show previous article +`n` or `Return` open current article in the default browser +`r` reload articles +`Ctrl Q` quit +`Ctrl +` zoom in +`Ctrl -` zoom out `Ctrl 0` reset zoom -== Trivia +## Trivia I just hacked together this one within one day so it is not feature complete yet and has no real error handling.