mirror of
https://github.com/zealdocs/zeal.git
synced 2024-11-23 22:37:09 +03:00
84 lines
3.4 KiB
Markdown
84 lines
3.4 KiB
Markdown
# Zeal
|
|
|
|
[](https://github.com/zealdocs/zeal/releases)
|
|
[](https://gitter.im/zealdocs/zeal)
|
|
[](https://kiwiirc.com/client/irc.freenode.net/#zealdocs)
|
|
[](https://telegram.me/zealdocs)
|
|
[](https://twitter.com/zealdocs)
|
|
|
|
Zeal is a simple offline documentation browser inspired by [Dash](https://kapeli.com/dash).
|
|
|
|
|
|
|
|
[More screenshots](https://imgur.com/a/eVi97)
|
|
|
|
## Build Status
|
|
|
|
[](https://scan.coverity.com/projects/4271)
|
|
|
|
| OS | Build Status |
|
|
| -------- | ------------ |
|
|
| Linux | [](https://app.shippable.com/projects/54ac2ce4d46935d5fbc19b84) |
|
|
| Windows | [](https://ci.appveyor.com/project/trollixx/zeal) |
|
|
|
|
## Download
|
|
|
|
Get binary builds for Windows and Linux from the [download page](https://zealdocs.org/download.html).
|
|
|
|
## How to use
|
|
|
|
After installing Zeal, go to *Tools->Docsets*, select the ones you want, and click the *Download* button.
|
|
|
|
## How to compile
|
|
|
|
### Required dependencies
|
|
|
|
* [CMake](https://cmake.org/).
|
|
* [Qt](https://www.qt.io/) version 5.5.1 or above. Required module: Qt WebKit Widgets.
|
|
* [libarchive](http://libarchive.org/).
|
|
* [SQLite](https://sqlite.org/).
|
|
* X11 platforms only: Qt X11 Extras and `xcb-util-keysyms`.
|
|
|
|
### Building instructions
|
|
|
|
```sh
|
|
mkdir build && cd build
|
|
cmake ..
|
|
make
|
|
```
|
|
|
|
More detailed instructions are available in the [Wiki](https://github.com/zealdocs/zeal/wiki).
|
|
|
|
## 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 the command line:
|
|
|
|
`zeal python:pprint`
|
|
|
|
## Creating your own docsets
|
|
|
|
Follow the [Dash Docset Generation Guide](https://kapeli.com/docsets).
|
|
|
|
## Contact and Support
|
|
|
|
We want your feedback! Here's a list of different ways to contact developers and request help:
|
|
* Report bugs and submit feature requests to [GitHub issues](https://github.com/zealdocs/zeal/issues).
|
|
* Reach developers and other Zeal users on [Gitter](https://gitter.im/zealdocs/zeal), or IRC channel #zealdocs on [Freenode](https://freenode.net/).
|
|
* Ask any questions in our [Google Group](https://groups.google.com/d/forum/zealdocs). You can simply send an email to zealdocs@googlegroups.com.
|
|
* Finally, for private communications email us at zeal@zealdocs.org.
|
|
* And do not forget to follow [@zealdocs](https://twitter.com/zealdocs) on Twitter!
|
|
|
|
## License
|
|
|
|
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](https://github.com/zealdocs/zeal/blob/master/COPYING) file and [online](http://opensource.org/licenses/gpl-3.0.html).
|