X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=README;h=1ec85a288726ed7ab1336c35fadbd499872158f9;hp=7d6167b5d09a95604e88b101271afd87d1f63344;hb=595a76dcdb44e7ae7e6495b255ca0f0a2141d991;hpb=006b96d6968bd6f4efd22c6cb4e3d0581a261cc3 diff --git a/README b/README index 7d6167b..1ec85a2 100644 --- a/README +++ b/README @@ -1,19 +1,20 @@ 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/. @@ -42,7 +43,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, @@ -54,13 +56,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". @@ -80,7 +82,35 @@ 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 by Tim Vaughan. Recent maintenance has +been done by and with the help of Alex Schroeder. In addition, the +following people (in alphabetical order) have generously provided +assistance and/or patches: + +* Alexis +* Christopher Brannon +* Zhiwei Chen +* condy0919 +* Étienne Deparis +* Roy Koushik +* Simon Nicolussi +* Noodles! +* Jens Östlund +* Abhiseck Paira +* F. Jason Park +* Omar Polo +* Koushk Roy +* Michel Alexandre Salim +* Alex Schroeder +* Daniel Semyonov +* Simon South +* Bradley Thornton +* Vee + +License ------- Elpher is free software and is distributed under the terms of version