diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..7ed6c1f --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,30 @@ + BSD license + =========== + +Copyright (c) 2015, Jeena Paradies +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +- Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +- Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +- Neither the name of Bungloo nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c990e94 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +Icon + +# 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 C++ with Qt and QML, it also uses WebKit to show the contents. + +You need to have Qt 5.4 installed be able to compile and have a account on a TinyTinyRSS server. +This version 2 is still in a early stage so there are no binaries available yet but will be +as soon as I figure out how to package and distribute them. + +License: BSD + +## Installation + +Clone the repo, install the Qt 5.4 SDK on your computer and use QtCreator to compile and run it. + +## 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 +`Ctrl 0` reset zoom + +On OS X use `Cmd` instead of `Ctrl`. + +## Trivia + +This is version 2 of FeedTheMonkey, you can find version 1 which was written in PyQt in the v1 branch +of this repo. My goal is to make this usable on many different targets, for now it is only for +the use on a desktop computer but I'd like to see it on a mobile device too. + +## Screenshot + +![Feed the Monkey screenshot](http://jabs.nu/feedthemonkey/screenshot.png) \ No newline at end of file