X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=README.md;h=6bd554e0f38b7d2a5b1d9c1fd46bfd908c51f8e5;hb=7cb2ba9c2cbd6e80f67b352e2882b575269c0522;hp=66d81db4ab9b7c4fd0923b777250289be494387b;hpb=6fa87bc75ae9e30aa84803984b6fea3dac905bc9;p=elpher.git diff --git a/README.md b/README.md index 66d81db..6bd554e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Elpher +Elpher +====== Elpher aims to provide a full-featured gopher client for GNU Emacs. @@ -9,23 +10,24 @@ It supports: - 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. +- clickable web and gopher links in plain text, +- a simple bookmark management system. -Keep the non-web internet alive! - -## Installation +Installation +------------ 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, using the following: +To install Elpher, enter the following: M-x package-install RET elpher RET To uninstall, use `M-x package-delete RET elpher RET`. -## Usage +Usage +----- Once installed, use `M-x elpher` to launch the browser. This will open a start page which documents the default key bindings and @@ -36,7 +38,8 @@ and a few other odds and ends, use the following: M-x customize-group RET elpher RET -## History and Caching +History and Caching +------------------- This is an aspect of Elpher that perhaps requires separate explanation. @@ -80,7 +83,8 @@ 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 +Licence +------- Elpher is free software and is distributed under the terms of version 3 the GNU General Public License, which can be found in the file named