~zeal-developers/zeal/master

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Jerzy Kozera
  • Date: 2013-01-20 01:49:25 UTC
  • Revision ID: git-v1:422bcfe23f9a4c097e9ab490cc152570d2c7a6b6
README and COPYING

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Zeal
 
2
 
 
3
**zeal**  
 
4
*noun*  
 
5
 
 
6
 1. a feeling of strong eagerness (usually in favor of a person or cause)
 
7
 2. excessive fervor to do something or accomplish some end
 
8
 3. prompt willingness
 
9
 
 
10
(from WordNet 3.0)
 
11
 
 
12
Zeal is a simple documentation browser inspired by [Dash](http://kapeli.com/dash/), but designed from scratch to avoid copyright issues.
 
13
 
 
14
[Screenshots (imgur)](http://imgur.com/a/crL3P)
 
15
 
 
16
## How to use
 
17
 
 
18
Currently Zeal requires Qt 5.0. After compiling it you need to download docsets and put them in `$HOME/.local/share/zeal/docsets/` -- after creating the directory first. Currently there are docsets available from Qt 5 and Python 2.7.3, generated using scripts from `gendoctests` directory, but for convenience can be downloaded from Dropbox:
 
19
 
 
20
 * [Qt5.tar.bz2](https://www.dropbox.com/s/o8uy2iz0wivs04j/Qt5.tar.bz2) (55M)
 
21
 * [python-2.7.3-docs-html.tar.bz2](https://www.dropbox.com/s/weve3snkc9gpqlj/python-2.7.3-docs-html.tar.bz2) (4.3M)
 
22
 
 
23
Do `tar -jxvf file.tar.bz2` in docsets directory to enable given docset.
 
24
 
 
25
## TODO
 
26
 
 
27
 * Alt+Space / configurable hotkey for showing Zeal + tray icon
 
28
 * Search enhancements - some ideas:
 
29
   1. Allow selecting subset of docsets to search in.
 
30
   2. Substring match in case current startswith matching doesn't return anything.
 
31
   3. Better sorting of results (currently they are grouped by docset, which is probably not a good idea)
 
32
 
 
33
 
 
34
## Contributions
 
35
 
 
36
Any feedback and pull requests are welcome. Before starting to implement anything larger, especially items from the TODO list above, it would be good to contact me at jerzy dot kozera at gmail, to avoid duplicating work.
 
37
 
 
38
Please keep in mind I'm not an experienced C++ programmer, so the code quality might be not great.
 
39
 
 
40
Also you can send bitcoins to 1Zea1QhPV5CGp8SNMpb2RHUvRrfNhKqGV to encourage development.