summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authordefanor <defanor@uberspace.net>2017-11-24 15:43:47 +0300
committerdefanor <defanor@uberspace.net>2017-11-24 15:43:47 +0300
commitd23c2cc82b3ebc0eb3d0f4d11ddea9e1dd96dbfc (patch)
tree922f15deed08b21394a05bd96c5ca9971c416027 /README
parent3a1c8854d0d08cdeaf089c750c8843be2d8df247 (diff)
Update README and convert it into reStructuredText
It's more readable as plain text this way.
Diffstat (limited to 'README')
-rw-r--r--README110
1 files changed, 110 insertions, 0 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