summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2009-08-23 05:18:39 +0200
committerJose Antonio Ortega Ruiz <jao@gnu.org>2009-08-23 05:18:39 +0200
commit3983e638629b1185963fc642c50c2138bd0e66fa (patch)
tree6306401198588a6fccb63351f5dabb86c8f032c6 /README
parent065ed08b64474ae86c98aaff7704ded34ce39e0a (diff)
downloadgeiser-3983e638629b1185963fc642c50c2138bd0e66fa.tar.gz
geiser-3983e638629b1185963fc642c50c2138bd0e66fa.tar.bz2
Standardese filling.
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 44 insertions, 13 deletions
diff --git a/README b/README
index 141b83d..537f291 100644
--- a/README
+++ b/README
@@ -26,29 +26,60 @@
- PLT Scheme 4.1.5.5 or better required.
* Installation
+ Geiser can be used either directly from its uninstalled source tree
+ or byte-compiled and installed after perfoming the standard
+ configure/make/make install dance.
- - In your .emacs:
+*** In place
+ - Extract the tarball or clone the git repository anywhere in your
+ file system. Let's call that place <path-to-geiser>.
+ - In your .emacs:
- (load-file "<path-to-geiser>/elisp/geiser.el")
+ (load-file "<path-to-geiser>/elisp/geiser.el")
- This installs all supported Scheme implementations. You can list
- explicitly the ones that you want by setting the variable
- `geiser-impl-installed-implementations' *before* loading geiser.el.
- For instance:
+*** Byte-compiled
+ - Create a build directory, `build', say:
+ $ cd <path-to-geiser>
+ $ mkdir build; cd build
+ - Configure and make:
+ $ ../configure && make
+ You'll have a directory called "elisp" which contains Geiser's
+ elisp bytecode. Now, you can either use it in place, with the
+ .emacs incantation:
- (setq geiser-impl-installed-implementations '(plt guile))
+ (load-file "<path-to-geiser>/build/elisp/geiser.elc")
- On opening a scheme file, Geiser will try to guess its Scheme,
- defaulting to the first in the list.
+ or install it with:
- - Check the geiser customization group for some options with:
+ $ make install
+
+ and require 'geiser-install (not 'geiser, mind you) in your emacs
+ initialization file:
+
+ (require 'geiser-install)
+
+ You're ready to go!
+
+* 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-impl-installed-implementations' *before*
+ loading geiser.el. For instance:
+
+ (setq geiser-impl-installed-implementations '(plt 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).
+
+ Check the geiser customization group for some options with:
M-x customize-group RET geiser RET
- In particular, customize `geiser-repl-<impl>-binary' (in
- geiser-repl), which should point to an executable in your path.
+ In particular, customize `geiser-repl-<impl>-binary' (in
+ geiser-repl), which should point to an executable in your path.
- - To start a REPL, M-x geiser.
+ To start a REPL, M-x geiser.
* Quick key reference