aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md85
-rw-r--r--screenshot.pngbin0 -> 63024 bytes
2 files changed, 27 insertions, 58 deletions
diff --git a/README.md b/README.md
index c27faf5..c25537f 100644
--- a/README.md
+++ b/README.md
@@ -1,58 +1,27 @@
-#---------------------------------------------------------
-# README
-#---------------------------------------------------------
-#
-# PURPOSE
-# This software enables the viewing of the info files
-# in html via webbrowser.
-#
-# REQUIREMENTS: PHP, Perl
-#
-# INSTALL
-# Unpack all files where you want them to live.
-# Review, edit (if necessary) and run the config.bsh script.
-# Add the generated alias to your .bashrc file.
-#
-# NOTE: Requires PHP,
-# The config.bsh script has the following defaults, change as
-# necessary:
-# PHP_PORT=8000
-# FAV_WEBBROWSER=firefox
-# DISCARD_DEV="/dev/random" ### If not Linux change to /dev/null
-#
-# E.g. After it's set up, run it as:
-# $> i2h coreutils wc invocation
-# or to view the info catalog
-# $> i2h
-#
-# ORIGINAL AUTHOR
-# Karl Guggisberg <karl.guggisberg@telscom.ch>
-#
-# AUTHORS
-# +A.M.Danischewski <adam_ lastname@not gamil.com> reworked the
-# code to be a quasi PHP-CGI, added config.bsh, routing.php.
-# Changed configuration to default to looking for the executables
-# and config file where they live, created alias 'i2h'.
-# info2html's original web page, which has become outdated.
-# Tim Witham <twitham@eng.fm.intel.com> made some bug fixes
-# Jon Howell <jonh@jonh.net> made a couple enhancements, added
-# infocat, and moved info2html to sourceforge. Talk to him if
-# you'd like to commit bug fixes/enhancements to the CVS tree.
-# Herbert J. Bernstein <yaya@bernstein-plus-sons.com> contributed
-# the un-gzip patch.
-# Serguei Sokol <sokol@insa-tlse.fr> contributed the un-bzip2
-# patch.
-#
-# HISTORY
-# 2015.12.25 V 2.1 Updated comment header, format and text.
-# +A.M.Danischewski <adam_ lastname@not gamil.com>
-
-The most recent version of this software can be found at:
- https://github.com/AdamDanischewski/info2html
-
-For older versions, documentation and installation instructions,
-see info2html's home page:
- http://info2html.sourceforge.net/
-
-See info2html's original home page (now very out-of-date):
- http://www.iam.unibe.ch/work/docs/info2html/
+# GNU Info plugin for Dillo
+
+[GNU Info](https://en.wikipedia.org/wiki/Info_%28Unix%29) plugin for [Dillo][].
+Renders info pages as HTML, based on the old
+[html2info](https://github.com/AdamDanischewski/info2html) Perl script.
+
+## Screenshot
+
+![Dillo loading info:libc/Memory](screenshot.png)
+
+## Install
+
+Requires `perl` with the `File::Basename` and `URI:Escape` modules.
+
+To install use:
+
+```sh
+$ make install
+```
+
+## Sites to try
+
+- <info:> or <info:dir> provides a directory of all pages.
+- <info:gcc> to load the top-level node in GCC file.
+- <info:gcc/Standards> go to a specific node in the GCC manual.
+
+[Dillo]: https://dillo-browser.github.io/
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..768fe8a
--- /dev/null
+++ b/screenshot.png
Binary files differ