about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2024-05-01 17:29:40 +0200
committerbptato <nincsnevem662@gmail.com>2024-05-01 17:29:40 +0200
commit21e79694f5d5da1a2098abae81b678b5144228a5 (patch)
tree5a44dacef70f1bff9493dc0173595c5f01df204a
parent2fdc5d2a95a4db8ab9600cc95632647a3da98e23 (diff)
downloadchawan-21e79694f5d5da1a2098abae81b678b5144228a5.tar.gz
Update readme
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index c859d872..83c00c5c 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ supported yet.)
 1. Clone the Chawan repository:
    `git clone https://git.sr.ht/~bptato/chawan && cd chawan`
 2. Install the Nim compiler: <https://nim-lang.org/install.html>
-	* Please use 1.6.14 or newer, ideally 2.0.2. Versions older than 1.6.14
+	* Please use 1.6.14 or newer, ideally 2.0.4. Versions older than 1.6.14
 	  will not work. (You can check your Nim compiler's version using
 	  `nim -v`.)
 3. Install the following dependencies:
@@ -63,7 +63,7 @@ Currently implemented features are:
 * JavaScript based navigation
 * JavaScript support in documents
 	* some basic DOM manipulation APIs are supported
-        * off by default; use is discouraged until sandboxing is implemented
+	* off by default; use is discouraged until sandboxing is implemented
 * cookies
 * supports several protocols: HTTP(S), FTP, Gopher, Gemini, Finger, etc.
 * can load user-defined protocols/file formats using [local CGI](doc/localcgi.md),
@@ -121,24 +121,25 @@ You can fix this manually by adjusting the `display.default-background-color`,
 Yes; Chawan now has a built-in markdown converter. If you don't like it, you
 can always [replace it](doc/mailcap.md) with e.g. pandoc.
 
-### I set Chawan as my PAGER and now man pages are unreadable.
+### I set my `$PAGER` to `cha` and now man pages are unreadable.
 
 TLDR: use mancha.
 
 Long explanation:
 
 Most `man` implementations print formatted manual pages by default, which
-Chawan *can* in fact automatically parse, *if* they are passed through standard
-input. Unfortunately, some `man` implementations (mandoc in particular) pass us
+Chawan *can* automatically parse if they are passed through standard input.
+
+Unfortunately, some `man` implementations (mandoc in particular) pass us
 the formatted document as a *file*, which Chawan reasonably interprets as plain
 text without formatting. (mandoc does not even set a useful file extension to
 guide us.)
 
 At this point you have two options:
 
-* Set PAGER='cha -T text/x-ansi', and see that man suddenly works as expected.
-* alias man=mancha in your bashrc, and see that man suddenly works better than
+* `export PAGER='cha -T text/x-ansi'` and see that man suddenly works as
   expected.
+* `alias man=mancha` and see that man suddenly works better than expected.
 
 It may be best to do both, to deal with annoying cases like git help which
 shells out to man directly.