branch: externals/realgud-lldb
commit f3318314e1defcd75b0b3970ed22b6cc8a54b846
Author: rocky <ro...@gnu.org>
Commit: rocky <ro...@gnu.org>
Fold INSTALL.md into README.md
---
INSTALL.md | 5 -----
Makefile.am | 2 +-
README.md | 25 +++++++++++++++++++++++++
3 files changed, 26 insertions(+), 6 deletions(-)
diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index 6b07102d3c..0000000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,5 +0,0 @@
-* Have `realgud` and `test-simple` installed.
-* From inside 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"))))
-```
diff --git a/Makefile.am b/Makefile.am
index 9b80116a89..e0d0f37313 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 231527ff7f..ceeff01c12 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,33 @@
[![MELPA][melpa-image]][melpa]
[![MELPA Stable][melpa-stable-image]][melpa-stable]
+Introduction
+------------
+
Emacs Lisp Module to add [lldb](https://lldb.llvm.org/) support to
[realgud](http://github.com/realgud/realgud).
+Installation
+------------
+
+From ELPA or MELPA
+++++++++++++++++++
+
+Inside GNU Emacs evaluate:
+
+```lisp
+ (package-install realgud-lldb)
+```
+
+
+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
