summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org24
1 files changed, 11 insertions, 13 deletions
diff --git a/README.org b/README.org
index a2b1b71..72d5315 100644
--- a/README.org
+++ b/README.org
@@ -1,6 +1,7 @@
-This is a CLI web/gopher/file browser inspired by [[https://en.wikipedia.org/wiki/Line_Mode_Browser][Line Mode Browser]].
+This is a CLI/emacs web/gopher/file browser inspired by [[https://en.wikipedia.org/wiki/Line_Mode_Browser][Line Mode
+Browser]].
-It combines [[http://pandoc.org/][pandoc]] with external downloaders such as [[https://curl.haxx.se/][curl]], adding
+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.
@@ -56,18 +57,15 @@ paginate: true
* Excluded features
-- Usage of content types reported by network protocols: HTTP content
- types are ignored, Gopher item types are used only loosely and
- indirectly, and pancake mostly relies on URIs for format detection.
- Usually it works, but can be improved -- though that would slightly
- complicate both the configuration and the codebase, which may be not
- worth it.
+The following features were not implemented, since the complication
+may be not worth the benefits, but maybe they will be in the future:
+
+- Usage of content types reported by network protocols: pancake relies
+ on URIs for format detection, what usually works, but can be
+ improved.
- Semantic markup for embedding: it might be useful to provide
- semantic markup to ~pancake-mode~ (and for embedding in general) in
- order to e.g. buttonize links (and embed images, perhaps), but it's
- tricky to draw a line between that and just serializing pandoc
- structures, skipping the rendering altogether. Simplicity would
- suffer, too.
+ denotations to ~pancake-mode~ (and for embedding in general) in
+ order to buttonize links, render TeX math, embed images, etc.
* Screenshots