summaryrefslogtreecommitdiffstats
path: root/desktop/nwg-readme-browser/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/nwg-readme-browser/README')
-rw-r--r--desktop/nwg-readme-browser/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/desktop/nwg-readme-browser/README b/desktop/nwg-readme-browser/README
new file mode 100644
index 0000000000..65135209c1
--- /dev/null
+++ b/desktop/nwg-readme-browser/README
@@ -0,0 +1,8 @@
+nwg-readme-browser (WebKitGTK-based README file browser)
+
+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.