diff options
author | Jose Antonio Ortega Ruiz <jao@gnu.org> | 2012-09-30 04:42:27 +0200 |
---|---|---|
committer | Jose Antonio Ortega Ruiz <jao@gnu.org> | 2012-09-30 04:42:27 +0200 |
commit | aba6733e848c47cb4f8e5d749add65be51d5d784 (patch) | |
tree | 65e58be6e724c58587a138216664152b365c1aed /doc | |
parent | 5ef6713714c875fb6a51e5504313c0f8963687be (diff) | |
download | geiser-guile-aba6733e848c47cb4f8e5d749add65be51d5d784.tar.gz geiser-guile-aba6733e848c47cb4f8e5d749add65be51d5d784.tar.bz2 |
Documentation updates0.2.2
Diffstat (limited to 'doc')
-rw-r--r-- | doc/geiser.texi | 3 | ||||
-rw-r--r-- | doc/install.texi | 72 | ||||
-rw-r--r-- | doc/macros.texi | 4 | ||||
-rw-r--r-- | doc/parens.texi | 12 | ||||
-rw-r--r-- | doc/repl.texi | 2 | ||||
-rw-r--r-- | doc/thanks.texi | 3 |
6 files changed, 78 insertions, 18 deletions
diff --git a/doc/geiser.texi b/doc/geiser.texi index 898bba6..d8c356d 100644 --- a/doc/geiser.texi +++ b/doc/geiser.texi @@ -68,7 +68,8 @@ Introduction Installation * Must needs:: -* Setting it up:: +* The easy and quick way:: +* From the source's mouth:: * Friends:: The REPL diff --git a/doc/install.texi b/doc/install.texi index 9a69464..70b73bd 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -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 diff --git a/doc/macros.texi b/doc/macros.texi index 5bf402d..3f9eb02 100644 --- a/doc/macros.texi +++ b/doc/macros.texi @@ -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}/@/geiser-@value{VERSION}.tar @set TARBALL geiser-@value{VERSION}.tar.gz @macro downfile{FILE, CAPT} diff --git a/doc/parens.texi b/doc/parens.texi index 3a6a0e0..f3693fc 100644 --- a/doc/parens.texi +++ b/doc/parens.texi @@ -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 diff --git a/doc/repl.texi b/doc/repl.texi index dcc1bd0..445811a 100644 --- a/doc/repl.texi +++ b/doc/repl.texi @@ -1,7 +1,7 @@ @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. diff --git a/doc/thanks.texi b/doc/thanks.texi index 87230c8..a614ed6 100644 --- a/doc/thanks.texi +++ b/doc/thanks.texi @@ -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. |