From c11c3003204ca38570afc789b3b0d5619e801105 Mon Sep 17 00:00:00 2001 From: Tim Vaughan Date: Mon, 11 Nov 2019 12:00:51 +0100 Subject: [PATCH] README is now not markdown. --- README.md => README | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) rename README.md => README (78%) diff --git a/README.md b/README similarity index 78% rename from README.md rename to README index ee2e7aa..0c75659 100644 --- a/README.md +++ b/README @@ -13,7 +13,7 @@ It supports: - jumping directly to links by name (with autocompletion), - a simple bookmark management system, - connections using TLS encryption, -- [the Gemini protocol](gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini). +- the Gemini protocol (gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini). The official home of elpher is gopher://thelambdalab.xyz/1/projects/elpher/. Please visit that page for development news and to leave feedback. @@ -24,7 +24,7 @@ Any suggestions for improvements are welcome! Installation ------------ -Elpher is available from [MELPA](https://melpa.org). If you have +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. @@ -32,35 +32,37 @@ To install Elpher, enter the following: M-x package-install RET elpher RET -To uninstall, use `M-x package-delete RET elpher RET`. +To uninstall, use + + M-x package-delete RET elpher RET Quick Start ----------- -Once installed, use `M-x elpher` to launch the browser. This will +Once installed, use "M-x elpher" to launch the browser. This will open a start page which documents the main key bindings and provides some links to help kick start your exploration of gopherspace. From here you can move point between links (which may be menu items or -inline URLs in text files) by using `TAB` and `Shift-TAB`, -as in Info. You can also jump directly to a menu item using `m`, or +inline URLs in text files) by using TAB and Shift-TAB, +as in Info. You can also jump directly to a menu item using "m", or use the standard Emacs or Evil motion and search commands to find your way around. To open a link, press enter. (Where a mouse is available, Clicking on a link with the mouse cursor has the same effect.) -To return to the page you just followed the link from, press `u`. +To return to the page you just followed the link from, press "u". Elpher caches (for the duration of an Emacs session) both page contents and the position of point on each of the pages (gopher menus, query results, or text pages) you visit, restoring these when you next visit -the same page. Thus, pressing `u` displays the previous page in +the same page. Thus, pressing "u" displays the previous page in exactly the same state as when you left, meaning that you can quickly and visually explore the different documents in a menu without having to wait for anything to reload. Of course, sometimes you'll _want_ to reload the current page -rather than stick with the cached version. To do this use `R`. +rather than stick with the cached version. To do this use "R". (This is particularly useful for search query results, where this allows you to perform a different search.) @@ -74,8 +76,8 @@ Full Documentation The full documentation for Elpher can be found in the Info manual, which should become automatically available if you install Elpher -using `M-x package-install`. To access it, select it from the root -Info directory which can be displayed using `C-h i`. +using "M-x package-install". To access it, select it from the root +Info directory which can be displayed using "C-h i". Licence ------- -- 2.20.1