From 189d142f8555aa80401096d91a887da4ad0c3b6e Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Mon, 2 Apr 2018 20:30:49 +0200 Subject: Trying harder to use proper org markup in README and make github happier in the process (cf. github issue #243) --- README | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README b/README index f3101a6..f61739a 100644 --- a/README +++ b/README @@ -52,10 +52,13 @@ not required for any other scheme. - Install the necessary support eggs: - $ chicken-install -s apropos chicken-doc + + $ chicken-install -s apropos chicken-doc + - Update the Chicken documentation database: - $ =cd `csi -p '(chicken-home)'`= - $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx + + $ =cd `csi -p '(chicken-home)'`= + $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx * Basic configuration @@ -163,22 +166,22 @@ ** In the documentation browser: |----------+----------------------------------------------| - | f | Next page | - | b | Previous page | + | =f= | Next page | + | =b= | Previous page | |----------+----------------------------------------------| - | TAB, n | Next link | - | S-TAB, p | Previous link | - | N | Next section | - | P | Previous section | + | =TAB=, =n= | Next link | + | =S-TAB=, =p= | Previous link | + | =N= | Next section | + | =P= | Previous section | |----------+----------------------------------------------| - | k | Kill current page and go to previous or next | - | g, r | Refresh page | - | c | Clear browsing history | + | =k= | Kill current page and go to previous or next | + | =g=, =r= | Refresh page | + | =c= | Clear browsing history | |----------+----------------------------------------------| - | ., M-. | Edit identifier at point | - | z | Switch to REPL | + | =.=, =M-.= | Edit identifier at point | + | =z= | Switch to REPL | |----------+----------------------------------------------| - | q | Bury buffer | + | =q= | Bury buffer | |----------+----------------------------------------------| ** In backtrace (evaluation/compile result) buffers: -- cgit v1.2.3