X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=README;h=6be2207c26fa10ac68418989505f53bf60e6d19f;hp=f03e860c961c9968bdc77dd27ba63ff394140ed1;hb=refs%2Fheads%2Fspartan;hpb=c9175aedfaf3daeca6b2414f74ef703f2f6cbc1f diff --git a/README b/README index f03e860..6be2207 100644 --- a/README +++ b/README @@ -1,19 +1,21 @@ Elpher ====== -Elpher aims to provide a full-featured gopher client for GNU Emacs. +Elpher aims to provide a full-featured combination gopher and gemini +client for GNU Emacs. It supports: - intuitive keyboard and mouse-driven browsing, - out-of-the-box compatibility with evil-mode, - clickable web and gopher links **in plain text**, - caching of visited sites, -- pleasant and configurable visualization of Gopher directories, +- pleasant and configurable visualization of gopher directories and + gemini pages, - direct visualisation of image files, - jumping directly to links by name (with autocompletion), - a simple bookmark management system, -- connections using TLS encryption, -- the Gemini protocol (gopher://gemini.circumlunar.space). +- gopher connections using TLS encryption, +- the Finger protocol. The official home of elpher is gopher://thelambdalab.xyz/1/projects/elpher/. Please visit that page for development news and to leave feedback. @@ -24,11 +26,17 @@ Any suggestions for improvements are welcome! 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. +Elpher is available on the non-GNU ELPA package archive. If you are +using Emacs 28 or later, this archive should be available on your system +by default. For Emacs 27, you'll need to follow the instructions at +https://elpa.nongnu.org to make the archive accessible. -To install Elpher, enter the following: +Alternatively, 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. + +Once one of these package archives is installed, enter the following to +install Elpher: M-x package-install RET elpher RET @@ -41,7 +49,8 @@ Quick Start 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. +some links to help kick start your exploration of gopher space and +gemini space. 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, @@ -53,13 +62,13 @@ effect.) 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 -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. +Elpher caches (for the duration of an Emacs session) both page +contents and the position of point on each of the pages (gopher menus, +gemini pages, query results, or text pages) you visit, restoring these +when you next visit 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". @@ -79,7 +88,34 @@ 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". -Licence +Contributors +------------ + +Elpher was originally written and is currently maintained by Tim Vaughan +. Significant improvements and +maintenance have also been contributed by and with the help of Alex +Schroeder . In addition, the following people have +all generously provided assistance and/or patches over the years: + +* Jens Östlund +* F. Jason Park +* Christopher Brannon +* Omar Polo +* Noodles! +* Abhiseck Paira +* Zhiwei Chen +* condy0919 +* Alexis +* Étienne Deparis +* Simon Nicolussi +* Michel Alexandre Salim +* Koushk Roy +* Vee +* Simon South +* Daniel Semyonov +* Bradley Thornton + +License ------- Elpher is free software and is distributed under the terms of version