From 21b28ea8bae006de0aa755daa970aea67e935996 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Fri, 28 May 2021 19:22:41 +0100 Subject: README: Reformat docker commands & add shortcuts table --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 17 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4b85462..eab2a6d 100644 --- a/README.md +++ b/README.md @@ -4,28 +4,53 @@ of the long-since defunct Google Reader, but with extra tweaks for later Tiny Tiny RSS functionality. ## Installation -Assuming that you're using the recommended Docker Compose setup, then -the easiest way to install the plugin `init.php` file is to use these docker -commands. This assumes that the current directory is where this README.md -and the init.php are: - - ```sh - docker exec ttrss-docker_app_1 /bin/mkdir /var/www/html/tt-rss/plugins.local/googlereaderkeys - docker cp init.php ttrss-docker_app_1:/var/www/html/tt-rss/plugins.local/googlereaderkeys - docker exec ttrss-docker_app_1 /bin/chown -R app:app /var/www/html/tt-rss/plugins.local/googlereaderkeys - docker exec ttrss-docker_app_1 /bin/chmod -R og+rX /var/www/html/tt-rss/plugins.local/googlereaderkeys - ``` +Assuming that you're using the recommended Docker Compose setup and that +the current directory is where this `README.md` and the `init.php` are, then +the easiest way to install the plugin is the following docker commands. + + +```sh +$ docker exec ttrss-docker_app_1 /bin/mkdir /var/www/html/tt-rss/plugins.local/googlereaderkeys +$ docker cp init.php ttrss-docker_app_1:/var/www/html/tt-rss/plugins.local/googlereaderkeys +$ docker exec ttrss-docker_app_1 /bin/chown -R app:app /var/www/html/tt-rss/plugins.local/googlereaderkeys +$ docker exec ttrss-docker_app_1 /bin/chmod -R og+rX /var/www/html/tt-rss/plugins.local/googlereaderkeys +``` If you're not using the Docker Compose setup then you'll have to execute the non-Docker equivalent. The key thing is to: - 1. Make a directory for this plugin, called `googlereaderkeys` (not - anything else, it has to match up with the class name in - init.php) inside your `plugins.local` directory. - 1. Copy the `init.php` file from here into that new directory. - 1. Ensure the owner and permissions are such that your web server - can access the directory and file. +1. Make a directory for this plugin, called `googlereaderkeys` (not + anything else, it has to match up with the class name in + init.php) inside your `plugins.local` directory. +1. Copy the `init.php` file from here into that new directory. +1. Ensure the owner and permissions are such that your web server + can access the directory and file. Now if you reload tt-rss in your browser and check the Plugins part of Preferences you should have a "googlereaderkeys" entry that you can activate. + +## Shortcuts +Assuming this document is up to date, then the changed/added shortcuts +are: + +| Key | Function | +| :-------- | :------------------------------- | +| j | next_article_noscroll | +| k | prev_article_noscroll | +| J | next_unread_feed | +| K | prev_unread_feed | +| N | next_feed | +| P | prev_feed | +| v | open_in_new_window | +| r | feed_refresh | +| m | toggle_unread | +| o | toggle_expand | +| Enter | toggle_expand | +| ? | help_dialog | +| Space | next_article | +| Up | article_scroll_up | +| Down | article_scroll_down | + +If in doubt check the `init.php` file, it should be as obvious as this +table. -- cgit v1.2.3