Update README and convert it into reStructuredText

It's more readable as plain text this way.

3 files changed, 111 insertions, 86 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b8c1198
--- /dev/null
+++ b/README
@@ -0,0 +1,110 @@
+                                                  .. -*- mode: rst -*-
+Pancake
+=======
+
+This is a CLI/Emacs web/gopher/file browser.
+
+It utilizes pandoc and external downloaders such as curl, adding
+support for Gopher directories and plain text files, and invoking
+external applications (e.g., image and PDF viewers) depending on its
+configuration.
+
+User interaction capabilities are rather basic, as it is intended to
+be combined with software that provides better user interfaces – such
+as emacs, rlwrap, tmux, screen.
+
+
+Installation
+------------
+
+Retrieval
+~~~~~~~~~
+
+There is a few ways to get a recent version of pancake:
+
+- source and binary distributions:
+  https://defanor.uberspace.net/projects/pancake/
+- git repository: https://git.uberspace.net/pancake/
+- github: https://github.com/defanor/pancake/
+
+
+Pancake
+~~~~~~~
+
+``cabal install`` would build and install pancake and its
+documentation. Alternatively, basic Debian packages and binary
+releases are available.
+
+
+Emacs interface
+~~~~~~~~~~~~~~~
+
+``M-x package-install-file RET /path/to/pancake.el RET``. To set it as
+your default emacs browser::
+
+  (require 'pancake)
+  (setq browse-url-browser-function 'pancake-browse-url)
+
+
+Commands
+--------
+
+:q: quit
+:b: back
+:f: forward
+:r: reload
+:re: reload config
+:[.]<number>: follow a link (or open the referenced file)
+:?: show current URI
+:RET (empty): show the next 2/3 of a page, if pagination is enabled
+:<URI>: follow an URI, possibly relative to the current one
+:<type> <URI>: same as above, but explicitly set a document type
+               (html, txt, org, markdown, etc)
+:<shortcut> <query>: run a query using a shortcut defined in the
+                     configuration (e.g., search)
+
+pancake-mode provides additional aliases and commands, see built-in
+emacs documentation (``C-h m``) for those.
+
+
+Configuration
+-------------
+
+Default configuration will be written into XDG configuration
+directory, and would look approximately like this::
+
+  externalViewers:
+    png: xdg-open "${FILE}"
+    hs: emacsclient -n "${FILE}"
+  indentDivs: false
+  commands:
+    gopher: torify curl "${URI}"
+    ssh: scp "${URI_REGNAME}:${URI_PATH}" /dev/stdout
+  defaultCommand: ! 'curl -4 -L "${URI}" -w "
+
+    -pancake-
+
+    uri: %{url_effective}
+
+    type: %{content_type}
+
+    "'
+  referenceDigits: 'stwpxcvazdg'
+  shortcuts:
+    g: https://m.gutenberg.org/ebooks/search.mobile/?query=
+    ddg: https://duckduckgo.com/lite/?q=
+    wt: https://en.m.wiktionary.org/w/index.php?search=
+    wp: https://en.m.wikipedia.org/wiki/Special:Search?search=
+    gp: gopher://gopherpedia.com:70/7/lookup?
+    vs: gopher://gopher.floodgap.com/7/v2/vs?
+    xiph: http://dir.xiph.org/search?search=
+  historyDepth: 100
+  paginate: true
+
+
+Screenshots
+-----------
+
+.. image:: https://defanor.uberspace.net/projects/pancake/gopher.png
+.. image:: https://defanor.uberspace.net/projects/pancake/web-gnu.png
+.. image:: https://defanor.uberspace.net/projects/pancake/emacs.png
diff --git a/README.org b/README.org
deleted file mode 100644
index 05fdde5..0000000
--- a/README.org
+++ /dev/null
@@ -1,85 +0,0 @@
-This is a CLI/emacs web/gopher/file browser inspired by [[https://en.wikipedia.org/wiki/Line_Mode_Browser][Line Mode
-Browser]].
-
-It utilizes [[http://pandoc.org/][pandoc]] and external downloaders such as [[https://curl.haxx.se/][curl]], adding
-support for Gopher directories and plaintext files, and invoking
-external applications (e.g., image and PDF viewers) depending on its
-configuration.
-
-User interaction capabilities are rather basic, as it is intended to
-be combined with software that provides better user interfaces -- such
-as emacs, rlwrap, tmux, screen.
-
-* Installation
-** Pancake
-~cabal install~ would build and install pancake and its documentation.
-Alternatively, basic Debian packages and binary releases are
-available.
-
-** Emacs interface
-~M-x package-install-file RET /path/to/pancake.el RET~. To set it as
-your default emacs browser:
-
-#+BEGIN_SRC elisp
-(require 'pancake)
-(setq browse-url-browser-function 'pancake-browse-url)
-#+END_SRC
-
-* Commands
-
-- [q]uit, [b]ack, [f]orward, [h]elp, [r]eload, [re]load config
-- [.]<number>: follow a link (or open the referenced file)
-- ?<number>: show link/image URI
-- ?: show current URI
-- RET (empty): show the next 2/3 of a page, if pagination is enabled
-- <URI>: follow an URI, possibly relative to the current one
-- <type> <URI>: same as above, but explicitly set a document type
-  (html, txt, org, markdown, etc)
-- <shortcut> <query>: run a query using a shortcut defined in the
-  configuration (e.g., search)
-
-pancake-mode provides additional aliases, see built-in emacs
-documentation (~C-h m~) for those.
-
-* Configuration
-
-Default configuration will be written into XDG configuration
-directory, and would look approximately like this:
-
-#+BEGIN_SRC yaml
-externalViewers:
-  png: xdg-open "${FILE}"
-  hs: emacsclient -n "${FILE}"
-indentDivs: false
-commands:
-  gopher: torify curl "${URI}"
-  ssh: scp "${URI_REGNAME}:${URI_PATH}" /dev/stdout
-defaultCommand: ! 'curl -4 -L "${URI}" -w "
-
-  -pancake-
-
-  uri: %{url_effective}
-
-  type: %{content_type}
-
-  "'
-referenceDigits: 'stwpxcvazdg'
-shortcuts:
-  g: https://m.gutenberg.org/ebooks/search.mobile/?query=
-  ddg: https://duckduckgo.com/lite/?q=
-  wt: https://en.m.wiktionary.org/w/index.php?search=
-  wp: https://en.m.wikipedia.org/wiki/Special:Search?search=
-  gp: gopher://gopherpedia.com:70/7/lookup?
-  vs: gopher://gopher.floodgap.com/7/v2/vs?
-  xiph: http://dir.xiph.org/search?search=
-historyDepth: 100
-paginate: true
-#+END_SRC
-
-* Screenshots
-
-[[https://defanor.uberspace.net/projects/pancake/gopher.png]]
-
-[[https://defanor.uberspace.net/projects/pancake/web-gnu.png]]
-
-[[https://defanor.uberspace.net/projects/pancake/emacs.png]]
diff --git a/pancake.cabal b/pancake.cabal
index 9eca57c..9b18b9e 100644
--- a/pancake.cabal
+++ b/pancake.cabal
@@ -16,7 +16,7 @@ bug-reports:         https://github.com/defanor/pancake/issues
 category:            Web
 build-type:          Custom
 extra-source-files:  ChangeLog.md
-                   , README.org
+                   , README
                    , pancake.el
                    , pancake.1
                    , Makefile