Browse files

ELPA-specific README

  • Loading branch information...
1 parent 79b9387 commit 597d3ce0bef5185d9e969fed733226db6ee796bb @jaor committed Jan 19, 2013
Showing with 42 additions and 2 deletions.
  1. +2 −2 Makefile.am
  2. +40 −0 README.elpa
View
4 Makefile.am
@@ -10,7 +10,7 @@ elpa_dir = $(abs_top_builddir)/$(elpa_name)
elpa_slogan = "GNU Emacs and Scheme talk to each other"
geiser_el = $(elpa_dir)/geiser.el
-elpa: info
+elpa: README.elpa info
rm -rf $(elpa_dir)
$(mkdir_p) $(elpa_dir)
@@ -34,7 +34,7 @@ elpa: info
$(INSTALL_DATA) $(srcdir)/doc/geiser.info $(elpa_dir)
(cd $(elpa_dir) && install-info --dir=dir geiser.info 2>/dev/null)
- $(INSTALL_DATA) $(top_srcdir)/README $(elpa_dir)
+ $(INSTALL_DATA) $(top_srcdir)/README.elpa $(elpa_dir)/README
$(mkdir_p) $(elpa_dir)/bin
$(INSTALL) $(top_srcdir)/bin/geiser-racket.sh $(elpa_dir)/bin/geiser-racket
View
40 README.elpa
@@ -0,0 +1,40 @@
+Geiser is a generic Emacs/Scheme interaction mode, featuring an
+enhanced REPL and a set of minor modes improving Emacs' basic scheme
+major mode.
+
+Geiser supports Racket and Guile.
+
+Main functionalities:
+
+ - Evaluation of forms in the namespace of the current module.
+
+ - Macro expansion.
+
+ - File/module loading.
+
+ - Namespace-aware identifier completion (including local bindings,
+ names visible in the current module, and module names).
+
+ - Autodoc: the echo area shows information about the signature of
+ the procedure/macro around point automatically.
+
+ - Jump to definition of identifier at point.
+
+ - Direct access to documentation, including docstrings (when the
+ implementation provides them) and user manuals.
+
+ - Listings of identifiers exported by a given module (Guile).
+
+ - Listings of callers/callees of procedures (Guile).
+
+ - Rudimentary support for debugging (list of
+ evaluation/compilation error in an Emacs' compilation-mode
+ buffer).
+
+ - Support for inline images in schemes, such as Racket, that treat
+ them as first order values.
+
+See http://www.nongnu.org/geiser/ for the full manual in HTML form, or
+the the info manual installed by this package.
+
+Author: http://hacks-galore.org/jao

0 comments on commit 597d3ce

Please sign in to comment.