zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-09-11 14:25:52 +03:00
Code Issues Projects Releases Wiki Activity
Offline documentation browser inspired by Dash
1,423 Commits 6 Branches 13 Tags 7.1 MiB
C++ 96.2%
CMake 2.5%
HTML 0.8%
PowerShell 0.4%
f9ce40edb8
Go to file
Jiahao Guo f9ce40edb8 doc: Fix grammar in README (#810)
2017-11-04 21:07:15 +02:00
assets assets,app: Optimize PNG files 2017-08-16 01:55:59 +03:00
cmake cmake,ui: Normalize line endings 2017-03-30 00:05:10 -04:00
qmake Bump version to 0.4.0 2017-08-31 01:51:59 +03:00
src core,util: Fix include guards 2017-10-31 10:10:17 +02:00
.gitattributes Add .gitattributes 2017-03-30 00:03:46 -04:00
.gitignore cmake: Introduce CMake-based build option 2017-02-19 21:09:24 -05:00
.qmake.conf qmake: Reorganize the whole project 2016-09-11 02:14:48 -04:00
.shippable.yml ci[shippable]: Install CMake 2017-04-11 08:46:55 -04:00
CMakeLists.txt Bump version to 0.4.0 2017-08-31 01:51:59 +03:00
COPYING README and COPYING 2013-01-20 01:49:25 +00:00
README.md doc: Fix grammar in README (#810) 2017-11-04 21:07:15 +02:00
zeal.pro qmake: Set Qt 5.5.1 as a minimally required Qt version 2017-02-12 23:29:39 -05:00

README.md

Zeal

Changelog Gitter Telegram Chat IRC Telegram Channel Twitter

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.

Screenshot

More screenshots

Build Status

Coverity Scan

OS \ Branch master stable
Linux Shippable Shippable
Windows AppVeyor AppVeyor

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 Tools->Docsets, select the ones you want, and click the Download button.

How to compile

Requirements

  • Qt version 5.5.1 or above. Required modules: Qt WebKit Widgets, Qt X11 Extras (X11 only).
  • libarchive.
  • X11 only: xcb-util-keysyms.

To compile Zeal run qmake and then make. Linux users can install Zeal with make install command.

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:bomb

Creating your own docsets

You can use Dash's instructions for generating 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.
  • Ask any questions in our Google Group. You can simply send an email to zealdocs@googlegroups.com.
  • For a quick chat with developers and other Zeal users use our IRC channel: #zealdocs on Freenode. Also available through Kiwi IRC web interface. Please, take into consideration possible time zone differences.
  • Finally, for private communications send us email.
  • And do not forget to follow @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 file and online.