branch: externals/bug-hunter
commit 9be61766ea496b9c47a8ff272a34f962d1ad161b
Author: Artur Malabarba <[email protected]>
Commit: Artur Malabarba <[email protected]>
Readme
---
README.md | 27 +++++++++++++++++++++++++++
README.org | 29 -----------------------------
2 files changed, 27 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1759f30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+## (Not done yet...) Bug Hunter 
[](https://travis-ci.org/Bruce-Connor/elisp-bug-hunter?branch%3Dmaster)
+
+`bug-hunter` is an Emacs library that finds the source of a bug inside any
given `.el` file.
+
+## Usage Examples
+
+1. If your Emacs init file signals an error during startup, but you
+ don’t know why, simply issue
+
+ M-x bug-hunter-init-file RET RET
+
+ and `bug-hunter` will find it for you.
+
+2. If Emacs starts up without errors but something is not working as
+ it should, invoke the same command, but give it in an assertion:
+
+ M-x bug-hunter-init-file RET (when issue-detected t) RET
+
+
+3. You can also use `bug-hunter-file` to hunt in other files, or even
+ `bug-hunter-hunt` to search in a list of expressions.
+
+## Installation
+It is part of Emacs and is available trough [GNU
Elpa](https://elpa.gnu.org/packages/bug-hunter.html). To install, issue
+
+ M-x package-install RET bug-hunter
+
diff --git a/README.org b/README.org
deleted file mode 100644
index 3d353ca..0000000
--- a/README.org
+++ /dev/null
@@ -1,29 +0,0 @@
-#+OPTIONS: toc:nil num:nil
-#+TITLE: Bug Hunter [[file:hunter.png]]
[[https://travis-ci.org/Bruce-Connor/elisp-bug-hunter?branch%3Dmaster][https://secure.travis-ci.org/Bruce-Connor/elisp-bug-hunter.png?branch=master]]
-
-~bug-hunter~ is an Emacs library that finds the source of a bug inside any
given ~.el~ file.
-
-* Usage Examples
-
-1. If your Emacs init file signals an error during startup, but you
- don’t know why, simply issue
- #+BEGIN_SRC text
- M-x bug-hunter-init-file RET RET
- #+END_SRC
- and ~bug-hunter~ will find it for you.
-
-2. If Emacs starts up without errors but something is not working as
- it should, invoke the same command, but give it in an assertion:
- #+BEGIN_SRC text
- M-x bug-hunter-init-file RET (when issue-detected t) RET
- #+END_SRC
-
-3. You can also use ~bug-hunter-file~ to hunt in other files, or even
- ~bug-hunter-hunt~ to search in a list of expressions.
-
-* Installation
-It is part of Emacs and is available trough
[[https://elpa.gnu.org/packages/bug-hunter.html][GNU Elpa]]. To install, issue
-
-#+BEGIN_SRC text
-M-x package-install RET bug-hunter
-#+END_SRC