summaryrefslogtreecommitdiff
path: root/readme.org
blob: 636f945dd25e9be8aeaebf33567c669d555c94f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#+TITLE: Chez and Geiser talk to each other
#+OPTIONS: d:nil
#+EXPORT_FILE_NAME: geiser-chez.texi
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Geiser Chez: (geiser-chez).
#+TEXINFO_DIR_DESC: Support for Chez in Geiser

#+html: <p align=right>
#+html: <a href="http://elpa.nongnu.org/nongnu/geiser-chez.html"><img alt="NonGNU Elpa" src="http://elpa.nongnu.org/nongnu/geiser-chez.svg"/> </a>
#+html: <a href="http://elpa.nongnu.org/nongnu-devel/geiser-chez.html"><img alt="NonGNU Devel Elpa" src="http://elpa.nongnu.org/nongnu-devel/geiser-chez.svg"/></a>
#+html: <a href="https://melpa.org/#/geiser-chez"><img alt="MELPA" src="https://melpa.org/packages/geiser-chez-badge.svg"/></a>
#+html: </p>

This package provides support for using [[https://cisco.github.io/ChezScheme/][Chez Scheme]] in Emacs with
[[http://geiser.nongnu.org][Geiser]].

* Installation

  The easiest way of installing this package is via 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 package-install RET geiser-chez RET
  #+end_src

  That will also install the ~geiser~ package, 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-chez.

** Manual installation

   Provided [[https://gitlab.com/emacs-geiser/geiser][geiser]] is installed in your system, if this package's directory is
   in your load path, just add ~(require 'geiser-chez)~ to your initialisation
   files.


* Start up

   You can use ~M-x geiser-chez~ to start a Chez REPL, or jump to geiser from
   any scheme buffer.

   If you don't have any other Geiser flavour installed, all scheme files
   should be automatically recognised as Chez-flavoured Geiser buffers.

** Tramp support

   Geiser-chez can be used remotely via tramp connections.  If you start a
   REPL session from a remote directory or file, the REPL process will be run
   in the machine where the tramp-accessed file lives, after copying there any
   necessary scheme libraries.