X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=README.md;h=34083368514be441b15290b1a101e2335dc5f7e7;hb=692b730680ee7b2f4f0b1f7b0b68ac4b84d5d8b1;hp=6f7f620cfe1ee14c015780ea4cbd0a4cfbd091c1;hpb=c5326528d6d3997c23259bf85b900543f07516c8;p=elpher.git diff --git a/README.md b/README.md index 6f7f620..3408336 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,17 @@ It supports: - caching of visited sites, - clean and configurable visualization of Gopher directories, - direct visualisation of image files, +- jumping directly to links by name (with autocompletion), - clickable web and gopher links in plain text. -Elpher is still under development. Planned features include: -- (m)enu key support, similar to the Emacs info browser, -- support for multiple Elpher buffers. - Keep the non-web internet alive! ## Installation -Installation instructions will be added soon. +To install, simply save the file `elpher.el` and use `M-x +package-install-file`, specifying the path to the saved elisp file. + +To uninstall, use `M-x package-delete`. ## Usage @@ -58,7 +58,7 @@ Elpher marks that node the current node, and extends the tree as follows: | | | | | o o o o o <- nodes representing entries in new directory -Pressing the 'u' button (introduced on page which opens when elopher starts) +Pressing the 'u' key (introduced on page which opens when elopher starts) always moves to the page representing "parent" node, whatever that is. Once a node is visited, its "contents" (i.e. whatever is retrieved @@ -68,6 +68,10 @@ the cached contents are displayed and the cursor returns to its previous position. This makes navigating amongst different documents referenced from within the same directory very snappy. +This hierarchy is also maintained when gopher URLs are followed from plain +text documents, and when directories are retrieved explicitly using the 'g' +key. + ## Licence Elpher is free software and is distributed under the terms of version