
 Dianara - A Pump.io client
 Copyright 2012-2016  JanKusanagi JRR <jancoding@gmx.com>

===============================================================================

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the
   Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.

   Or visit http://www.gnu.org/licenses/

===============================================================================


Dianara is a Pump.io application for the desktop.
With it, you can access your Pump.io account without using a web browser.


If you only got the source code, see the INSTALL file for instructions on
how to build it.

Dianara looks best under Plasma Desktop, preferably using a very complete
iconset, like the Oxygen icons, but these are not requirements, just a
recommendation.
You can make the program look nicer in other environments by using 'qtconfig'
and setting a visual theme to your liking.

Press F1 (or click on the Help menu) from Dianara's main window to check out
the basic help.



What it does
===============================================================================

 - Posting text (with some HTML formatting), to Followers, Public,
   custom person lists created by you, or specific people, in any combination.

 - Uploading pictures, audio, video and general files.

 - Showing different timelines, with configurable number of posts per page,
   moving forward and backward in pages, or jumping to any page directly.

 - Liking, commenting, sharing, editing and deleting posts.

 - Liking, editing and deleting comments.

 - Contact listing, following and unfollowing, either by entering their
   webfinger address or through buttons in the lists and in the avatar menus.

 - Editing your profile, changing your avatar, setting your e-mail address.

 - Watch the 'minor feeds' of activities, "Meanwhile", "Mentions" and "Actions",
   and opening related posts and following people from there.

 - Filtering or highlighting posts, according to a set of configurable rules.

 - Popup notifications when there are new posts, or new "Meanwhile" activities.

 - And more!



Some usage tips
===============================================================================

 - Press F1 in the program to read the general help.

 - You can set "public posting" as the default in the Configuration window.

 - You can click on the avatar of a post's author to get some options.
   This also works in the comments, and in the Meanwhile feed.

 - There are tooltips everywhere, so if you hover over a button or a text
   field with your mouse, you'll probably see some extra information.
   This is specially useful in the "Meanwhile" column.

 - When publishing a note or posting a comment, you can send using the
   keyboard, by pressing Control+Enter.

 - You can use Control+Up/Down/PgUp/PgDown/Home/End to scroll the timeline.
   Use Control+Left/Right to go forward and backwards in the timeline pages.
   Press Control+G to jump to any page. Control+1/2/3 alternate between the
   minor feeds.

 - If a post is of "image" type, you can click on the image to see it full size.

 - You can hide/show the side panel by pressing F9.
   Many items in the "Meanwhile" column have a "+" button to open the
   referenced post.

 - Adding titles to your posts will make the "Meanwhile" feed and the e-mail
   notifications a lot more useful! You can have automatic titles set from
   attachments if you enable that option in the program configuration, in the
   Composer category.

 - Resizing the window to half the screen width usually looks better, even
   though you can use it maximized, or in full screen mode, of course.

 - You can change the main window's icon and the icon used in system
   notifications by placing a 64x64 PNG image called dianara.png
   into /usr/share/icons/hicolor/64x64/apps/

 - You can temporarily stop (and restart) the auto-updating of timelines
   by clicking on the "state" icon in the status bar, or by using the
   Session > Auto-update Timelines option.

 - If you connect to the Internet through a proxy, you can set it up in the
   program settings.

 - If your desktop environment is Plasma 5, but older than 5.5.0, you will
   need the SNI Qt plugin in order for the system tray icon to appear.

 - Dianara offers a D-Bus interface that allows some control from other
   applications. The interface is at org.nongnu.dianara, and you can access
   it with tools such as qdbus or dbus-send. It offers methods like 'toggle'
   and 'post'.



See the BUGS and TODO files for a list of known issues.
If you find a bug not listed there, you can report it at the issue tracker:
https://gitlab.com/dianara/dianara-dev/issues



Command line parameters
===============================================================================

 - You can use the --config (or -c) command line parameter to specify that a
   different configuration file be used.
   For example, if you run "dianara --config myotheraccount", the config file
   in use will be "Dianara_myotheraccount.conf" instead of the usual
   "Dianara.conf". This way, you can switch between different accounts easily.
   You can even run two instances of Dianara at the same time.
   You can use any name you wish to identify the configuration, but it must be
   one word, no spaces.

 - Use the --debug (or -d) command line parameter to have detailed debugging
   information on what the program is doing.

 - If your server does not support HTTPS, you can use the --nohttps parameter.

 - If you need to connect to a server with a invalid SSL configuration, such
   as a self-signed certificate or an expired certificate, you can use the
   --ignoresslerrors parameter. This is not recommended.



Languages
===============================================================================

Dianara is available in English, Catalan, Spanish, Italian, German and Hebrew.
There is a polish translation in the works.

If you're interested in translating it to your language, check out the
TRANSLATING file, and let me know. It's quite easy to do and it would be
much appreciated!


===============================================================================


Visit https://jancoding.wordpress.com/dianara for more information.

Get the latest development source from https://gitlab.com/dianara/dianara-dev
