X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=README.md;h=2d71ad8d42f40d834c9be472f0ff479fdf61e0c2;hb=3c0aac7af8aa0dbe0619efa149ad1030191cc604;hp=6f7f620cfe1ee14c015780ea4cbd0a4cfbd091c1;hpb=c5326528d6d3997c23259bf85b900543f07516c8;p=elpher.git diff --git a/README.md b/README.md index 6f7f620..2d71ad8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Elpher +[![MELPA Stable](https://stable.melpa.org/packages/elpher-badge.svg)](https://stable.melpa.org/#/elpher) +[![MELPA](https://melpa.org/packages/elpher-badge.svg)](https://melpa.org/#/elpher) + Elpher aims to provide a full-featured gopher client for GNU Emacs. It supports: @@ -8,17 +11,22 @@ 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. +Elpher is available from [MELPA](https://melpa.org). If you have +never installed packages from this repository before, you'll need +to follow the instructions at https://melpa.org/#/getting-started. + +To install Elpher, enter the following: + + M-x package-install RET elpher RET + +To uninstall, use `M-x package-delete RET elpher RET`. ## Usage @@ -27,8 +35,9 @@ open a start page which documents the default key bindings and provides some links to help kick start your exploration of gopherspace. To customize the various faces Elpher uses, the start page -and a few other odds and ends, simply use `M-x customize-group` -and enter "elpher" at the group prompt. +and a few other odds and ends, use the following: + + M-x customize-group RET elpher RET ## History and Caching @@ -58,15 +67,21 @@ 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 -from the gopher server) are recorded with the corresponding node. The -cursor position (point) is also stored. If the node is visited again, -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. +from the gopher server) are recorded in memory with the corresponding +node. The cursor position (point) is also stored. If the node is +visited again in the same session, 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. (To conserve memory, this caching isn't by +default applied to images entries viewed in the browser.) + +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