summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile.am2
-rw-r--r--README.md23
2 files changed, 24 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index fda03c1..c1f6c8f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -15,7 +15,7 @@ include common.mk
PHONY=check clean dist distclean test check-short check-terse install-short
-EXTRA_DIST = common.mk.in INSTALL.md README.md THANKS $(lisp_files)
+EXTRA_DIST = common.mk.in README.md THANKS $(lisp_files)
if MAINTAINER_MODE
diff --git a/README.md b/README.md
index ccce1b0..37564e4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
+Introduction
+============
+
Emacs Lisp Module to add [trepan-xpy](https://github.com/rocky/trepan-xpy/) support to [realgud](http://github.com/realgud/realgud).
+
+
+Installation
+=============
+
+From github source
+------------------
+
+* Have `realgud` and `test-simple` installed.
+* From inside GNU Emacs, evaluate:
+```lisp
+ (compile (format "EMACSLOADPATH=:%s:%s ./autogen.sh" (file-name-directory (locate-library "test-simple.elc")) (file-name-directory (locate-library "realgud.elc"))))
+```
+
+[travis-image]: https://api.travis-ci.org/realgud/realgud-lldb.svg?branch=master
+[travis-url]: https://travis-ci.org/realgud/realgud-lldb
+[melpa-stable-image]: http://stable.melpa.org/packages/realgud-lldb-badge.svg
+[melpa-stable]: http://stable.melpa.org/#/realgud-lldb
+[melpa-image]: http://melpa.org/packages/realgud-lldb-badge.svg
+[melpa]: http://melpa.org/#/realgud-lldb