nwg-readme-browser

This program is a part of the nwg-shell project.

Nwg-readme-browser was conceived as rtfm with a graphical user interface. It searches the /usr/share/doc path for README.* files, and displays them in WebKit2.WebView. It supports .md, .rst, .html and plain text. It does not support .pdf format. Although the program was written with nwg-shell for sway and Hyprland in mind, it may also be used standalone.

Usage

Use the side menu to select the README file to preview. Basic navigation is provided by toolbar at the top of the side bar. Below it there is a search entry that allows you to filter the file list.

Arguments

Instead of all README.* files, the program may only display those that belong to packages enumerated in the config file, or the internally defined set (nwg-shell-related). Use a command line argument for this.

$ nwg-readme-browser -h
usage: nwg-readme-browser [-h] [-v] [-i] [-c]

options:
  -h, --help      show this help message and exit
  -v, --version   show program's version number and exit
  -i, --internal  only list Internally defined packages (nwg-shell components)
  -c, --config    only list packages enumerated in the `~/.config/nwg-icon-
                  browser/config.json` file

Installation

Clone the repository and run the install.sh script.

Configuration

The config file is placed in ~/.config/nwg-readme-browser/config.json (unless you set the $XDG_CONFIG_HOME variable a different way). By default, it looks as below:

{
  "doc-dir": "/usr/share/doc",
  "default-zoom": 1.0,
  "packages": [
    "nwg-package-1",
    "nwg-package-2",
    "(...)"
  ]
}

• "doc-dir": path where we look for directories with README files
• "default-zoom": default zoom level when the program starts
• "packages": list of packages that the program running with the --config argument will look for

You may preinstall your own config file. Otherwise, it will be created on first run, on the basis of --internal defaults.