summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2018-04-02 20:24:47 +0200
committerJose Antonio Ortega Ruiz <jao@gnu.org>2018-04-02 20:24:47 +0200
commitf53df56df2491c3d8ea039db3df598587100c8e5 (patch)
tree7c06d327e54cd35cc631e44d1da769472ea0fc96
parent23bc15197dfed3773283b2cacbda47678635f22a (diff)
downloadgeiser-guile-f53df56df2491c3d8ea039db3df598587100c8e5.tar.gz
geiser-guile-f53df56df2491c3d8ea039db3df598587100c8e5.tar.bz2
Trying to use proper org markup in README
And thus avoiding having to generate markdown (cf. github issue #243)
-rw-r--r--README122
1 files changed, 61 insertions, 61 deletions
diff --git a/README b/README
index 5118a0e..f3101a6 100644
--- a/README
+++ b/README
@@ -31,7 +31,7 @@
Geiser needs Emacs 23.2 or better, and at least one of the
supported scheme implementations:
- - Guile 2.0 or better.
+ - Guile 2.2 or better.
- PLT Racket 6.0 or better.
- Chicken 4.8.0 or better.
- MIT/GNU Scheme 9.1.1 or better.
@@ -41,7 +41,7 @@
* Installation
The easiest way is to use MELPA, and just type
- `M-x package-install RET geiser` inside emacs.
+ =M-x package-install RET geiser= inside emacs.
Geiser can be used either directly from its uninstalled source tree
or byte-compiled and installed after performing the standard
@@ -54,35 +54,35 @@
- Install the necessary support eggs:
$ chicken-install -s apropos chicken-doc
- Update the Chicken documentation database:
- $ cd `csi -p '(chicken-home)'`
+ $ =cd `csi -p '(chicken-home)'`=
$ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx
* Basic configuration
The loading invocations above install all supported Scheme
implementations. You can list explicitly the ones that you want by
- setting the variable `geiser-active-implementations' *before*
- loading geiser.el. For instance:
+ setting the variable =geiser-active-implementations= *before* loading
+ geiser.el. For instance:
(setq geiser-active-implementations '(chicken guile))
- On opening a scheme file, Geiser will try to guess its Scheme,
- defaulting to the first in the list. Use `C-c C-s' to select the
- implementation by hand (on a per file basis).
+ On opening a scheme file, Geiser will try to guess its Scheme,
+ defaulting to the first in the list. Use =C-c C-s= to select the
+ implementation by hand (on a per file basis).
Check the geiser customization group for some options with:
M-x customize-group RET geiser RET
- In particular, customize `geiser-<impl>-binary', which should point
+ In particular, customize =geiser-<impl>-binary=, which should point
to an executable in your path.
- To start a REPL, M-x geiser.
+ To start a REPL, =M-x geiser=.
** Completion with company-mode
Geiser offers identifier and module name completion, bound to
- M-TAB and M-` respectively. Only names visible in the current
+ =M-TAB= and =M-`= respectively. Only names visible in the current
module are offered.
While that is cool and all, things are even better: if you have
@@ -95,69 +95,69 @@
** In Scheme buffers:
|-------------+--------------------------------------------------|
- | C-c C-z | Switch to REPL |
- | C-c C-a | Switch to REPL and current module |
- | C-c C-s | Specify Scheme implementation for buffer |
+ | =C-c C-z= | Switch to REPL |
+ | =C-c C-a= | Switch to REPL and current module |
+ | =C-c C-s= | Specify Scheme implementation for buffer |
|-------------+--------------------------------------------------|
- | M-. | Go to definition of identifier at point |
- | M-, | Go back to where M-. was last invoked |
- | C-c C-e m | Ask for a module and open its file |
- | C-c C-e C-l | Add a given directory to Scheme's load path |
- | C-c C-e [ | Toggle between () and [] for current form |
+ | =M-.= | Go to definition of identifier at point |
+ | =M-,= | Go back to where =M-.= was last invoked |
+ | =C-c C-e m= | Ask for a module and open its file |
+ | =C-c C-e C-l= | Add a given directory to Scheme's load path |
+ | =C-c C-e [= | Toggle between () and [] for current form |
|-------------+--------------------------------------------------|
- | C-M-x | Eval definition around point |
- | C-c C-c | Eval definition around point |
- | C-c M-e | Eval definition around point and switch to REPL |
- | C-x C-e | Eval sexp before point |
- | C-c C-r | Eval region |
- | C-c M-r | Eval region and switch to REPL |
- | C-c C-b | Eval buffer |
- | C-c M-b | Eval buffer and switch to REPL |
+ | =C-M-x= | Eval definition around point |
+ | =C-c C-c= | Eval definition around point |
+ | =C-c M-e= | Eval definition around point and switch to REPL |
+ | =C-x C-e= | Eval sexp before point |
+ | =C-c C-r= | Eval region |
+ | =C-c M-r= | Eval region and switch to REPL |
+ | =C-c C-b= | Eval buffer |
+ | =C-c M-b= | Eval buffer and switch to REPL |
|-------------+--------------------------------------------------|
- | C-c C-m x | Macro-expand definition around point |
- | C-c C-m e | Macro-expand sexp before point |
- | C-c C-m r | Macro-expand region |
+ | =C-c C-m x= | Macro-expand definition around point |
+ | =C-c C-m e= | Macro-expand sexp before point |
+ | =C-c C-m r= | Macro-expand region |
|-------------+--------------------------------------------------|
- | C-c C-k | Compile and load current buffer |
- | C-c C-l | Load scheme file |
- | C-u C-c C-k | Compile and load current buffer, restarting REPL |
+ | =C-c C-k= | Compile and load current buffer |
+ | =C-c C-l= | Load scheme file |
+ | =C-u C-c C-k= | Compile and load current buffer, restarting REPL |
|-------------+--------------------------------------------------|
- | C-c C-d d | See documentation for identifier at point |
- | C-c C-d s | See short documentation for identifier at point |
- | C-c C-d i | Look up manual for identifier at point |
- | C-c C-d m | See a list of a module's exported identifiers |
- | C-c C-d a | Toggle autodoc mode |
+ | =C-c C-d d= | See documentation for identifier at point |
+ | =C-c C-d s= | See short documentation for identifier at point |
+ | =C-c C-d i= | Look up manual for identifier at point |
+ | =C-c C-d m= | See a list of a module's exported identifiers |
+ | =C-c C-d a= | Toggle autodoc mode |
|-------------+--------------------------------------------------|
- | C-c < | Show callers of procedure at point |
- | C-c > | Show callees of procedure at point |
+ | =C-c <= | Show callers of procedure at point |
+ | =C-c >= | Show callees of procedure at point |
|-------------+--------------------------------------------------|
- | M-TAB | Complete identifier at point |
- | M-`, C-. | Complete module name at point |
- | TAB | Complete identifier at point or indent |
- | | (If `geiser-mode-smart-tab-p' is t) |
+ | =M-TAB= | Complete identifier at point |
+ | =M-`=, =C-.= | Complete module name at point |
+ | =TAB= | Complete identifier at point or indent |
+ | | (If =geiser-mode-smart-tab-p= is t) |
|-------------+--------------------------------------------------|
** In the REPL
|-------------+----------------------------------------------------|
- | C-c C-z | Start Scheme REPL, or jump to previous buffer |
- | C-c M-o | Clear scheme output |
- | C-c C-q | Kill Scheme process |
- | C-c C-l | Load scheme file |
- | C-c C-k | Nuke REPL: use it if the REPL becomes unresponsive |
+ | =C-c C-z= | Start Scheme REPL, or jump to previous buffer |
+ | =C-c M-o= | Clear scheme output |
+ | =C-c C-q= | Kill Scheme process |
+ | =C-c C-l= | Load scheme file |
+ | =C-c C-k= | Nuke REPL: use it if the REPL becomes unresponsive |
|-------------+----------------------------------------------------|
- | M-. | Edit identifier at point |
- | TAB, M-TAB | Complete identifier at point |
- | M-`, C-. | Complete module name at point |
- | M-p, M-n | Prompt history, matching current prefix |
+ | =M-.= | Edit identifier at point |
+ | =TAB=, =M-TAB= | Complete identifier at point |
+ | =M-`=, =C-.= | Complete module name at point |
+ | =M-p=, =M-n= | Prompt history, matching current prefix |
|-------------+----------------------------------------------------|
- | C-c C-m | Set current module |
- | C-c C-i | Import module into current namespace |
- | C-c C-r | Add a given directory to scheme's load path |
+ | =C-c C-m= | Set current module |
+ | =C-c C-i= | Import module into current namespace |
+ | =C-c C-r= | Add a given directory to scheme's load path |
|-------------+----------------------------------------------------|
- | C-c C-d C-d | See documentation for symbol at point |
- | C-c C-d C-m | See documentation for module |
- | C-c C-d C-a | Toggle autodoc mode |
+ | =C-c C-d C-d= | See documentation for symbol at point |
+ | =C-c C-d C-m= | See documentation for module |
+ | =C-c C-d C-a= | Toggle autodoc mode |
|-------------+----------------------------------------------------|
** In the documentation browser:
@@ -183,5 +183,5 @@
** In backtrace (evaluation/compile result) buffers:
- - M-g n, M-g p, C-x ` for error navigation.
- - q to bury buffer.
+ - =M-g n=, =M-g p=, =C-x `= for error navigation.
+ - =q= to bury buffer.