summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjao <jao@gnu.org>2021-12-05 20:09:08 +0000
committerjao <jao@gnu.org>2021-12-05 20:09:08 +0000
commit961bb01d1930d1edef07cdb3f91fe140f9617caf (patch)
tree6ca9047f61436688457d30a140e04fe38d56ca19
parentadf31d3a36bf9be4b92d5c8854b4a055b1ef6f1f (diff)
downloadgeiser-guile-961bb01d1930d1edef07cdb3f91fe140f9617caf.tar.gz
geiser-guile-961bb01d1930d1edef07cdb3f91fe140f9617caf.tar.bz2
Documentation bits
-rw-r--r--readme.org31
1 files changed, 30 insertions, 1 deletions
diff --git a/readme.org b/readme.org
index 07e6980..be01e6b 100644
--- a/readme.org
+++ b/readme.org
@@ -9,4 +9,33 @@ your initialisation files and then ~M-x run-guile~ to start a REPL.
Scheme files with a Guile module declaration should be automatically
recognised as Guile-flavoured Geiser buffers.
-The easiest way of installing this package is using MELPA.
+The easiest way of installing this package is using NonGNU Elpa or
+MELPA. If you're in Emacs 28 or higher, the former is already enabled
+and all you need is the familiar
+
+#+begin_src elisp
+ M-x install-package RET geiser-guile RET
+#+end_src
+
+That will also install geiser, and its fine info manual. Please refer
+to it (or its [[https://geiser.nongnu.org][online version]]) for a general description of how geiser
+schemes work. We provide below some additional details specific to
+geiser-guile.
+
+*** Start up
+
+ When launching the Guile REPL, geiser will invoke the binary
+ configured in ~geiser-guile-binary~ (simply "guile" by default)
+ which in turn will load ~geiser-guile-init-file~, if any.
+
+ Note, however, that specifying ~geiser-guile-init-file~ is /not/
+ equivalent to changing Guile's initialization file (=~/.guile=),
+ because the former is loaded using the =-l= flag, together with =-q=
+ to disable loading the second. But there are subtle differences
+ in the way Guile loads the initialization file versus how it loads
+ a file specified via the =-l= flag. If what you want is just
+ loading =~/.guile=, leave ~geiser-guile-init-file~ alone and set
+ ~geiser-guile-load-init-file-p~ to ~t~ instead.
+
+ One can also provide a global list of paths to add to Guile's
+ =%load-path= via ~geiser-guile-load-path~.