ELPA-specific README
authorJose Antonio Ortega Ruiz <jao@gnu.org>
Sat, 19 Jan 2013 17:53:35 +0000 (19 18:53 +0100)
committerJose Antonio Ortega Ruiz <jao@gnu.org>
Sat, 19 Jan 2013 17:53:35 +0000 (19 18:53 +0100)
Makefile.am
README.elpa [new file with mode: 0644]

index ab2ec90..10fa07c 100644 (file)
@@ -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
diff --git a/README.elpa b/README.elpa
new file mode 100644 (file)
index 0000000..6b1cd66
--- /dev/null
@@ -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