https://github.com/mdh34/quickdocs

quickly read developer documentation
https://github.com/mdh34/quickdocs

devdocs devhelp elementary quickdocs valadoc

Last synced: about 1 month ago
JSON representation

quickly read developer documentation

• Host: GitHub
• URL: https://github.com/mdh34/quickdocs
• Owner: mdh34
• License: gpl-3.0
• Created: 2017-12-28T13:39:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-12T14:31:41.000Z (over 3 years ago)
• Last Synced: 2024-10-30T13:37:52.812Z (2 months ago)
• Topics: devdocs, devhelp, elementary, quickdocs, valadoc
• Language: Vala
• Size: 4.49 MB
• Stars: 105
• Watchers: 3
• Forks: 11
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        

# quickDocs ![Icon](https://github.com/mdh34/quickDocs/raw/master/data/icons/64/com.github.mdh34.quickdocs.svg?sanitize=true)

[![build](https://travis-ci.org/mdh34/quickDocs.svg?branch=master)](https://travis-ci.org/mdh34/quickDocs)

[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)](https://appcenter.elementary.io/com.github.mdh34.quickdocs)

A fast developer docs reader

![Screenshot](https://raw.githubusercontent.com/mdh34/quickDocs/master/data/images/screenshot-1.png)

![Screenshot](https://raw.githubusercontent.com/mdh34/quickDocs/master/data/images/screenshot-4.png)

## Doc Sources:

 - Valadoc

 - DevDocs

## Build Dependencies:

 - libarchive-dev

 - libdevhelp-dev

 - libgee-0.8-dev

 - libgranite-dev

 - libgtk-3-dev

 - libwebkit2gtk-4.0-dev

 - meson

 - valac

## Install:

### Flatpak:

 quickDocs is avaliable on Flathub, install it by running:

 ```

 flatpak install flathub com.github.mdh34.quickdocs

 ```

### Unofficial Community Packages:

 - For Arch Linux based systems, install the AUR package from [here](https://aur.archlinux.org/packages/quickdocs/)

 - For OpenSUSE Leap / Tumbleweed, add the following [repo](https://build.opensuse.org/package/show/home:MichaelAquilina/quickdocs)

## Install From Source:

The following instructions should work on most debian-based systems:

```

sudo apt install libarchive-dev libdevhelp-dev libgee-0.8-dev libgranite-dev libgtk-3-dev libwebkit2gtk-4.0-dev meson valac

git clone https://github.com/mdh34/quickDocs.git

cd ./quickDocs/

meson build --prefix=/usr

cd build

ninja

sudo ninja install

```