zeal/README.md

Zeal

zeal noun

1. a feeling of strong eagerness (usually in favor of a person or cause)
2. excessive fervor to do something or accomplish some end
3. prompt willingness

(from WordNet 3.0)

Zeal is a simple offline documentation browser inspired by Dash.

More screenshots

Build Status

OS \ Branch	Unstable (master)	Stable (0.1)
Linux
Windows

Download

Get binary builds for Windows and Linux from the download page.

How to use

After installing Zeal, you need to download docsets. Go to File->Options->Docsets, select the ones you want, and click the Download button.

How to compile

If you prefer to compile Zeal manually.

Requirements

• Qt (version 5.2.0 or above is required)
• libarchive
• Optionally libappindicator for Unity users

To compile it, run qmake and make.

Query & Filter docsets

You can limit the search scope by using ':' to indicate the desired docsets.

java:BaseDAO

You can also search multiple docsets separating them with a comma:

python,django:string

Command line

If you prefer, you can start Zeal with a query from command line:

zeal python:bomb

Creating your own docsets

You can use Dash's instructions for generating docsets.