2015-04-01 00:34:21 -07:00
# Zeal
2015-01-15 16:03:50 -08:00
2016-09-18 17:22:28 -04:00
[](https://github.com/zealdocs/zeal/releases)
2017-08-28 20:38:55 +03:00
[](https://gitter.im/zealdocs/zeal)
2021-07-10 20:08:32 -04:00
[](https://web.libera.chat/#zealdocs )
2016-09-18 17:22:28 -04:00
[](https://telegram.me/zealdocs)
[](https://twitter.com/zealdocs)
2014-11-26 03:40:36 +01:00
2023-03-18 22:59:41 -04:00
[](https://github.com/zealdocs/zeal/actions/workflows/build-check.yml)
2018-10-19 01:27:06 -04:00
[](https://scan.coverity.com/projects/4271)
2015-09-09 01:37:56 -04:00
Zeal is a simple offline documentation browser inspired by [Dash ](https://kapeli.com/dash ).
2013-01-20 01:49:25 +00:00
2018-01-22 01:05:20 +02:00
2013-02-01 20:23:56 +00:00
2013-03-30 14:45:30 +00:00
## Download
2015-09-09 01:37:56 -04:00
Get binary builds for Windows and Linux from the [download page ](https://zealdocs.org/download.html ).
2013-01-20 01:49:25 +00:00
## How to use
2020-07-07 00:09:49 -04:00
After installing Zeal go to `Tools->Docsets` , select the ones you want, and click the `Download` button.
2013-03-06 22:50:11 +00:00
## How to compile
2020-07-07 00:09:49 -04:00
### Build dependencies
2017-11-16 01:23:06 +02:00
* [CMake ](https://cmake.org/ ).
2020-04-27 01:17:12 +02:00
* [Qt ](https://www.qt.io/ ) version 5.9.5 or above. Required module: Qt WebEngine Widgets.
2020-06-29 00:26:14 -04:00
* [libarchive ](https://libarchive.org/ ).
2017-11-16 01:23:06 +02:00
* [SQLite ](https://sqlite.org/ ).
* X11 platforms only: Qt X11 Extras and `xcb-util-keysyms` .
2020-07-07 00:09:49 -04:00
### Build instructions
2017-11-16 01:23:06 +02:00
``` sh
2020-07-07 00:09:49 -04:00
cmake -B build
cmake --build build
2017-11-16 01:23:06 +02:00
```
2014-01-28 22:38:20 +01:00
2020-07-07 00:09:49 -04:00
More detailed instructions are available in the [wiki ](https://github.com/zealdocs/zeal/wiki ).
2013-03-06 22:50:11 +00:00
2014-10-13 16:55:05 -03:00
## Query & Filter docsets
2015-05-17 23:56:05 -07:00
You can limit the search scope by using ':' to indicate the desired docsets:
2014-10-13 16:55:05 -03:00
`java:BaseDAO`
You can also search multiple docsets separating them with a comma:
`python,django:string`
## Command line
2017-11-05 03:07:15 +08:00
If you prefer, you can start Zeal with a query from the command line:
2014-10-13 16:55:05 -03:00
2017-12-10 17:25:45 +02:00
`zeal python:pprint`
2014-10-13 16:55:05 -03:00
2020-07-07 00:09:49 -04:00
## Create your own docsets
2013-02-10 20:00:17 +01:00
2020-07-07 00:09:49 -04:00
Follow instructions in the [Dash docset generation guide ](https://kapeli.com/docsets ).
2015-04-15 20:18:22 -07:00
## Contact and Support
We want your feedback! Here's a list of different ways to contact developers and request help:
2021-07-18 00:46:36 -04:00
2015-04-15 20:18:22 -07:00
* Report bugs and submit feature requests to [GitHub issues ](https://github.com/zealdocs/zeal/issues ).
2023-04-15 21:26:39 -04:00
* Reach developers and other Zeal users in `#zealdocs` IRC channel on [Libera Chat ](https://libera.chat ) ([web client ](https://web.libera.chat/#zealdocs )).
* Ask any questions in our [GitHub discussions ](https://github.com/zealdocs/zeal/discussions ).
2020-07-07 00:09:49 -04:00
* Do not forget to follow [@zealdocs ](https://twitter.com/zealdocs ) on Twitter!
2023-04-15 21:26:39 -04:00
* Finally, for private communication shoot an email to support@zealdocs .org.
2019-09-03 02:27:06 +00:00
2015-04-18 14:28:10 -07:00
## License
2023-03-18 23:28:55 -04:00
This software is licensed under the terms of the GNU General Public License version 3 (GPLv3). Full text of the license is available in the [COPYING ](COPYING ) file and [online ](https://www.gnu.org/licenses/gpl-3.0.html ).
