Об этом проекте

Zeal — это настольное приложение для просмотра документации в оффлайн-режиме. Оно представляет собой персональную библиотеку справочных материалов, которую можно мгновенно искать и использовать без подключения к сети. Его дизайн был изначально вдохновлён Dash, и он читает тот же формат docset, поэтому существующие docset-ы для Dash совместимы. Начало работы: после установки откройте Файл → Библиотека docset, выберите нужные docset-ы и нажмите Скачать. Скачанные docset-ы остаются на локальном компьютере и используются для поиска. Поведение поиска: область поиска можно сузить, добавив в начало запроса имя docset с двоеточием, например cpp:vector. Можно искать по нескольким docset-ам одновременно, разделяя их имена запятыми, например python,django:string. Zeal также можно запустить с запросом из командной строки, например zeal python:pprint. Распространение: проект опубликован на Flathub (org.zealdocs.Zeal) и в Snap Store, а бинарные сборки для Windows и другие варианты установки перечислены на странице загрузки проекта. В README указано, что сборки для Windows требуют Windows 10 версии 1809 или выше. Сборка из исходников: в README есть ссылка на вики проекта для актуальных инструкций по каждой платформе, а также краткий обзор. Перечислены зависимости для сборки: CMake, Ninja, Qt 6.4.2 или выше (с модулями Svg и WebEngine в дополнение к Qt Base), libarchive и SQLite; для Linux и BSD также нужны extra-cmake-modules, а для платформ X11 — libxkbcommon и xcb-util-keysyms. Документированные шаги сборки — это пресеты CMake cmake --preset release, за которым следует cmake --build --preset release, что создаёт build/release/zeal (zeal.exe на Windows). Вы можете создать свои собственные docset-ы, следуя руководству по генерации docset для Dash. Вклады приветствуются через CONTRIBUTING.md репозитория, где описано, как собрать проект, какие конвенции соблюдать и чего ожидать от проверки. Варианты поддержки и связи, перечисленные в README, включают вопросы на GitHub для багов и предложений, обсуждения на GitHub для вопросов, Discord для общения с разработчиками и другими пользователями, канал Telegram для объявлений, аккаунт @zealdocs на X для новостей и адрес электронной почты для частных или конфиденциальных дел. Лицензирование: Zeal распространяется под лицензией GNU General Public License версии 3 или выше, полный текст которой находится в файле COPYING. Встроенные сторонние компоненты сохраняют свои собственные лицензии, и репозиторий соответствует требованиям REUSE, все тексты лицензий хранятся в директории LICENSES.