Issue tracker links pointing to Github's
[geiser.git] / INSTALL
blob5148ea41d580b2b9aa052df988dd970a361e9c37
1 Installing Geiser.
2 ------------------
4 Geiser is usable from its source tree, with no configuration
5 whatsoever, or can be installed from ELPA with `M-x install-package'
6 is Marmalade is in your list of archives.  You can also (byte) compile
7 and install it with the usual configure/make/make install dance.
9 * From ELPA
11 Add Marmalade to your `package-archives' list:
13   (require 'package)
14   (add-to-list 'package-archives
15     '("marmalade" . "http://marmalade-repo.org/packages/"))
16   (package-initialize)
18 and run `M-x install-package RET geiser`.  You can also use
19 http://download.savannah.gnu.org/releases/geiser/packages as a repo,
20 or download directly the package from there and use M-x
21 package-install-file.
23 * In place
24     - Extract the tarball or clone the git repository anywhere in your
25       file system. Let's call that place <path-to-geiser>.
26     - In your .emacs:
28       (load-file "<path-to-geiser>/elisp/geiser.el")
30 * Byte-compiled
31     - Create a build directory, `build', say:
32       $ cd <path-to-geiser>
33       $ mkdir build; cd build
34     - Configure and make:
35       $ ../configure && make
37     Now, you can use the byte-compiled Geiser in place by adding to
38     your .emacs:
40     (load "<path-to-geiser>/build/elisp/geiser-load")
42     or, alternatively, install it with:
44     $ make install
46     (you might need to get root access, depending on your installation
47     directory) and, instead of the above load forms, require
48     'geiser-install (not 'geiser, mind you) in your emacs
49     initialization file:
51     (require 'geiser-install)
53     You're ready to go!
55 Geiser's makefile accepts also all those other standard autotools
56 targets that you've come to know and love and that are documented
57 in virtually all boilerplate INSTALL files out there.