/vienna-rss

Vienna is a free and open-source RSS/Atom newsreader for macOS

Primary LanguageObjective-CApache License 2.0Apache-2.0

Vienna

Build Status Crowdin Gitter chat

Vienna is an RSS/Atom reader for macOS.

Vienna can connect directly to the websites you want to track. Additionally or alternatively, you can also sync with a server supporting the Open Reader API (an adaptation of the now deceased Google Reader API). Vienna has been successfully tested with BazQux.com, FreshRSS.org, FeedHQ.org, InoReader.com and TheOldReader.com.

Compatibility

Since version 3.2, Vienna requires a minimum of OS X 10.9 (Mavericks).

Vienna 3.1.x requires a minimum of OS X 10.8 (Mountain Lion). Vienna 3.0.x requires a minimum of OS X 10.6 (Snow Leopard).

Installing

Admins upload release and test versions at bintray and Sourceforge.
Alternatively, you can download releases from the GitHub Releases page.

Homebrew

Vienna is also available as a Cask for Homebrew Cask.

brew cask install vienna

Getting support

If the in-application help files and the FAQs don’t answer your questions, head over to our Support forum which is hosted by Cocoaforge.

Reporting an issue

If after reading the forum and asking your questions there, you are convinced that there is a problem in Vienna's code or an important feature is missing, you may open an issue on Github.

Be concise, but as precise as possible to allow other people reproducing the issue. To keep things short, you can provide a link to a relevant thread or message on the Cocoaforge forum.

Contributing

Want to contribute? Great! There are many ways you can, even if you aren't a developer.

Localizing

We need help keeping Vienna translations up to date into different languages. Apart from English, here are the languages for which a localization effort has started:

  • Basque (eu)
  • Simplified Chinese (zh-Hans)
  • Traditional Chinese (zh-Hant)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • French (fr)
  • Galician (gl)
  • German (de)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Portuguese (pt)
  • Brazilian Portuguese (pt-BR)
  • Russian (ru)
  • Spanish (es)
  • Swedish (sv)
  • Turkish (tr)
  • Ukrainian (uk)

You can contribute localizations at Crowdin. Registration is required, but the account is free. If you want to contribute for a language that is not yet listed, then contact us. Do not localize the project's *.strings files directly. Localizable *.plist files have to be localized directly.

Writing custom styles

Vienna supports a variety of different display styles for articles. These styles are provided on the Styles sub-menu off the View menu. A style is a combination of an HTML template that is used to control the placement of various parts of the article and a CSS stylesheet that controls the appearance of the article.

You can write styles by referring to this document. Have a look at existing styles in the Styles folder.

Writing plugins

Vienna supports plugins which are installed in menus and/or on the toolbar and can run defined actions. These plugins are XML-based and can be created by editing a simple .plist-file without any knowledge of Cocoa programming, in as little as 15 minutes.

You can write plugins by referring to this document. Have a look at existing plugins in the Plugins folder.

Writing code

Please check CONTRIBUTING.md.

Vienna now uses Carthage for managing dependencies.

Licensing

Apache License, Version 2.0.