mirror of
https://github.com/zealdocs/zeal.git
synced 2026-08-29 16:40:51 +08:00
Oleg Shparber
58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
# Zeal
|
|
|
|
[](https://app.shippable.com/projects/54ac2ce4d46935d5fbc19b84/builds/latest) [](https://kiwiirc.com/client/irc.freenode.net/#zealdocs)
|
|
|
|
**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](http://kapeli.com/dash/).
|
|
|
|
|
|
|
|
[More screenshots](http://imgur.com/a/eVi97)
|
|
|
|
## Download
|
|
|
|
For details about binary packages (currently available for Windows and Ubuntu) see [downloads page](http://zealdocs.org/download.html). Also, the latest unstable builds are available [here]( https://bitbucket.org/zealdocs/zeal-win32-binary-downloads/downloads).
|
|
|
|
## 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](https://www.qt.io/) (version 5.2.0 or above is required)
|
|
* [libarchive](http://libarchive.org/)
|
|
* Optionally [libappindicator](https://launchpad.net/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 with Zeal queries from command line, for this, use the option `--query`:
|
|
|
|
`zeal --query python:bomb`
|
|
|
|
## Creating your own docsets
|
|
|
|
You can use [Dash's instructions for generating docsets](http://kapeli.com/docsets).
|