À propos du projet

Zeal est une application de bureau pour parcourir la documentation hors ligne. Elle se présente comme une bibliothèque de référence personnelle, instantanément recherchable et utilisable sans connexion. Son design a été initialement inspiré par Dash, et elle lit le même format de docset, rendant ainsi les docsets Dash existants utilisables. Pour commencer : après l’installation, ouvrez Fichier → Bibliothèque de docsets, choisissez les docsets dont vous avez besoin et cliquez sur Télécharger. Les docsets téléchargés restent sur la machine locale et sont utilisés pour la recherche. Comportement de la recherche : la portée de la recherche peut être affinée en préfixant une requête avec le nom d’un docset suivi de deux points, par exemple cpp:vector. Plusieurs docsets peuvent être recherchés simultanément en séparant leurs noms par des virgules, par exemple python,django:string. Zeal peut également être lancé avec une requête depuis la ligne de commande, comme zeal python:pprint. Distribution : le projet est publié sur Flathub (org.zealdocs.Zeal) et le Snap Store, et des builds binaires pour Windows ainsi que d’autres options d’installation sont listées sur la page de téléchargement du projet. Le README indique que les builds Windows nécessitent Windows 10 version 1809 ou ultérieure. Compilation depuis les sources : le README renvoie au wiki du projet pour des instructions à jour par plateforme, et donne un aperçu minimal. Il liste comme dépendances de compilation CMake, Ninja, Qt 6.4.2 ou ultérieur (avec les modules Svg et WebEngine en plus de Qt Base), libarchive et SQLite ; les plateformes Linux et BSD nécessitent en plus extra-cmake-modules, et les plateformes X11 nécessitent libxkbcommon et xcb-util-keysyms. Les étapes de compilation documentées sont les presets CMake cmake --preset release suivis de cmake --build --preset release, produisant build/release/zeal (zeal.exe sur Windows). Vous pouvez créer vos propres docsets en suivant le guide de génération de docset Dash. Les contributions sont bienvenues via le CONTRIBUTING.md du dépôt, qui décrit comment compiler le projet, les conventions à suivre et ce à quoi s’attendre lors de l’examen. Les options de support et de contact listées dans le README incluent les issues GitHub pour les bugs et les demandes de fonctionnalités, les discussions GitHub pour les questions, Discord pour discuter avec les développeurs et les autres utilisateurs, un canal Telegram pour les annonces, le compte @zealdocs sur X pour les nouvelles, et une adresse email pour les questions privées ou sensibles. Licence : Zeal est distribué sous la licence GNU General Public License version 3 ou ultérieure, avec le texte complet dans le fichier COPYING. Les composants tiers inclus conservent leurs propres licences, et le dépôt est déclaré conforme à REUSE, avec tous les textes de licence stockés dans le répertoire LICENSES.