Commit aba6733e authored by jao's avatar jao

Documentation updates

parent 5ef67137
This diff is collapsed.
* Version 0.2.2
* Version 0.2.2 (Sep 30, 2012)
- ELPA support. We have now ELPA packages. Thanks to Grant Rettke
and Daniel Hackney.
* Version 0.2.1 (Sep 15, 2012)
......
......@@ -34,43 +34,16 @@
- PLT Racket 5.3 or better.
* 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 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")
*** Byte-compiled
- Create a build directory, `build', say:
$ cd <path-to-geiser>
$ mkdir build; cd build
- Configure and make:
$ ../configure && make
Now, you can use the byte-compiled Geiser in place by adding to
your .emacs:
(load "<path-to-geiser>/build/elisp/geiser-load")
or, alternatively, install it with:
The easiest way is to use ELPA/Marmalade, and just type
`M-x install-package RET geiser` inside emacs.
$ make install
(you might need to get root access, depending on your installation
directory) and, instead of the above load forms, require
'geiser-install (not 'geiser, mind you) in your emacs
initialization file:
(require 'geiser-install)
You're ready to go!
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. See the INSTALL file for more details.
* 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*
......@@ -91,7 +64,8 @@
To start a REPL, M-x geiser.
*** Completion with company-mode
** Completion with company-mode
Geiser offers identifier and module name completion, bound to
M-TAB and M-` respectively. Only names visible in the current
module are offered.
......@@ -105,7 +79,7 @@
* Quick key reference
*** In Scheme buffers:
** In Scheme buffers:
|-------------+-------------------------------------------------|
| C-c C-z | Switch to REPL |
......@@ -145,7 +119,7 @@
| | (If `geiser-mode-smart-tab-p' is t) |
|-------------+-------------------------------------------------|
*** In the REPL
** In the REPL
|-------------+----------------------------------------------------|
| C-c C-z | Start Scheme REPL, or jump to previous buffer |
......@@ -166,7 +140,7 @@
| C-c C-d C-a | Toggle autodoc mode |
|-------------+----------------------------------------------------|
*** In the documentation browser:
** In the documentation browser:
|----------+----------------------------------------------|
| f | Next page |
......@@ -187,7 +161,7 @@
| q | Bury buffer |
|----------+----------------------------------------------|
*** In backtrace (evaluation/compile result) buffers:
** In backtrace (evaluation/compile result) buffers:
- M-g n, M-g p, C-x ` for error navigation.
- q to bury buffer.
......@@ -13,6 +13,9 @@ ideas and bug reports.
Michael Wilber convinced me that image support for Racket was not only
fun, but easy, with the best argument: actual code!
Daniel Hackney and Grant Rettke created the first ELPA packages for
Geiser and taught me to fish.
Eduardo Cavazos' contagious enthusiasm has helped in many ways to keep
Geiser alive, and he's become its best evangelist in R6RS circles.
......
......@@ -68,7 +68,8 @@ Introduction
Installation
* Must needs::
* Setting it up::
* The easy and quick way::
* From the source's mouth::
* Friends::
The REPL
......
......@@ -3,11 +3,12 @@
@menu
* Must needs::
* Setting it up::
* The easy and quick way::
* From the source's mouth::
* Friends::
@end menu
@node Must needs, Setting it up, Installation, Installation
@node Must needs, The easy and quick way, Installation, Installation
@section Must needs
@cindex supported versions
......@@ -28,13 +29,67 @@ better
Since Geiser supports multiple REPLs, having both of them will just add
to the fun.
You'll also need Geiser itself. The quickest installation is via its
ELPA package, as described in the next section. If you prefer to use
the source code directly, it's not that difficult either: just keep on
reading.
@node The easy and quick way, From the source's mouth, Must needs, Installation
@section The easy and quick way
@cindex quick install
@cindex ELPA
Did i mention that the easiest way of installing Geiser is using its
@uref{http://emacswiki.org/emacs/ELPA, ELPA} package? If you're using
Emacs 24, @uref{http://emacswiki.org/emacs/ELPA, ELPA} is already there;
for earlier versions, the page i just linked to twice will tell you
where to find the goodies.
ELPA packages live in repositories accessible via HTTP. You can find
Geiser's package either in @uref{http://marmalade-repo.org, Marmalade}
or in Geiser's repository, located at
@code{http://download.savannah.gnu.org/releases/geiser/packages}. To
tell Emacs that a repo exists, you add it to @code{package-archives}:
@example
(require 'package)
(add-to-list 'package-archives
'("marmalade" . "http://marmalade-repo.org/packages/"))
;; You don't need this one if you have marmalade:
;; (add-to-list 'package-archives
;; '("geiser" . "http://download.savannah.gnu.org/releases/geiser/packages"))
(package-initialize)
@end example
And then installing Geiser is as easy as:
@example
M-x install-package RET geiser RET
@end example
Alternatively, you can manually download the @uref{@value{PACKAGE},
package file}, and install from your local disk with @kbd{M-x
package-install-file}
With that, you are pretty much all set up. See @ref{The REPL} to start
using Geiser.
@ifnotinfo
And, by the way, if you prefer to keep reading this manual within Emacs,
@kbd{C-h i m Geiser RET} will bring you to the info version of it that
you just installed!
@end ifnotinfo
@node From the source's mouth, Friends, The easy and quick way, Installation
@section Installing from source
@subsubheading Downloading Geiser
@cindex use the source, Luke
You'll also need Geiser itself. The latest release tarball can be found
@downfile{, here}, while older versions are @uref{@value{OLD_DOWN_BASE}/,
here}. Just download @downfile{@value{TARBALL}, @value{TARBALL}}
and untar it in a directory of your choice.
The latest release tarball can be found @downfile{, here}, while older
versions are @uref{@value{OLD_DOWN_BASE}/, here}. Just download
@downfile{@value{TARBALL}, @value{TARBALL}} and untar it in a directory
of your choice.
If you feel like living on the bleeding edge, just grab Geiser from its
Git repository @uref{http://git.savannah.nongnu.org/cgit/geiser.git/, over
......@@ -60,8 +115,7 @@ synchronized with the one at Savannah.
Either way, you'll now be in possession of a copy of Geiser's libre
code. I'll follow you into its directory and the next section.
@node Setting it up, Friends, Must needs, Installation
@section Setting it up
@subsubheading Setting it up
Geiser is ready to be used out of the box without much more ado. For the
sake of concreteness, let's assume you put its source in the directory
......@@ -155,7 +209,7 @@ manual, in Info format, where Emacs can find it, so you can continue to
learn about Geiser inside its natural habitat. See you there and into
the next chapter!
@node Friends, , Setting it up, Installation
@node Friends, , From the source's mouth, Installation
@section Friends
Although Geiser does not need them, it plays well with (and is enhanced
......
......@@ -4,7 +4,9 @@
@set RACKET_VERSION 5.3
@set EMACS_VERSION 23.2
@set DOWN_BASE https://github.com/@/jaor/@/geiser/@/downloads
@set OLD_DOWN_BASE http://download.savannah.nongnu.org/@/releases/@/geiser
@set OLD_DOWN_BASE http://download.savannah.gnu.org/@/releases/@/geiser
@set PACKAGE_REPO @value{OLD_DOWN_BASE}/@/packages
@set PACKAGE @value{PACKAGE_REPO}/@/[email protected]{VERSION}.tar
@set TARBALL [email protected]{VERSION}.tar.gz
@macro downfile{FILE, CAPT}
......
......@@ -34,12 +34,12 @@ process giving you the REPL, make those Scheme buffers come to life.
@cindex geiser-mode
@img{geiser-mode, right} With Geiser installed following any of the
procedures described in @ref{Setting it up}, Emacs will automatically
activate @i{geiser-mode} when opening a Scheme buffer. Geiser also
instructs Emacs to consider files with the extension @file{rkt} part of
the family, so that, in principle, there's nothing you need to do to
ensure that Geiser's extensions will be available, out of the box, when
you start editing Scheme code.
procedures described in @ref{The easy and quick way} or @ref{From the
source's mouth}, Emacs will automatically activate @i{geiser-mode} when
opening a Scheme buffer. Geiser also instructs Emacs to consider files
with the extension @file{rkt} part of the family, so that, in principle,
there's nothing you need to do to ensure that Geiser's extensions will
be available, out of the box, when you start editing Scheme code.
Indications that everything is working according to plan include the
'Geiser' minor mode indicator in your mode-line and the appearance of a
......
@node The REPL
@chapter The REPL
@anchor{quick-start}
If you've followed the instructions in @ref{Setting it up}, your Emacs is
If you've followed the instructions in @ref{Installation}, your Emacs is
now ready to start playing. Otherwise, i'll wait for you: when you're
ready, just come back here and proceed to the following sections.
......
......@@ -16,6 +16,9 @@ ideas and bug reports.
Michael Wilber convinced me that image support for Racket was not only
fun, but easy, with the best argument: actual code!
Daniel Hackney and Grant Rettke created the first ELPA packages for
Geiser and taught me to fish.
Eduardo Cavazos' contagious enthusiasm has helped in many ways to keep
Geiser alive, and he's become its best evangelist in R6RS circles.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment