[elpa] externals/bug-hunter e81cfe7 54/95: readme

[Stefan Monnier]

branch: externals/bug-hunter
commit e81cfe7586785eb851281968f8c5e49690cce868
Author: Artur Malabarba <bruce.connor.am@gmail.com>
Commit: Artur Malabarba <bruce.connor.am@gmail.com>

    readme
---
 README.org | 36 ++++++++++++++++--------------------
 1 file changed, 16 insertions(+), 20 deletions(-)

diff --git a/README.org b/README.org
index 7485af3..78e355d 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,8 @@
 #+OPTIONS: toc:nil num:nil
-#+TITLE: [[file:hunter.png]] Bug Hunter 
[[https://travis-ci.org/Bruce-Connor/elisp-bug-hunter?branch%3Dmaster][https://secure.travis-ci.org/Bruce-Connor/elisp-bug-hunter.png?branch=master]]
+#+TITLE: [[file:hunter.png]] The Bug Hunter 
[[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 an error or
-unexpected behavior inside an elisp configuration file (tipically
+The Bug Hunter is an Emacs library that finds the source of an error
+or unexpected behavior inside an elisp configuration file (tipically
 ~init.el~ or ~.emacs~).
 
 * Usage Examples
@@ -12,7 +12,7 @@ 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.
+and The Bug Hunter will find it for you.
 
 If Emacs starts up without errors but something is not working as it
 should, invoke the same command, but give it in an assertion.
@@ -32,23 +32,19 @@ M-x bug-hunter-init-file RET (featurep 'cl) RET
 *That’s it!* You’ll be given a nice buffer reporting the results:
 
 [[file:cl-example.png]]
-- Are you getting obscure errors when trying to open /“.tex”/
-  files? Don’t despair! Just use ~(find-file "dummy.tex")~ as the
-  assertion.
-- Did ~ox-html~ stop working due to some arcane misconfiguration? Just
-  write an assertion that does an export and checks the result.
-- Does some random command suddenly bind itself to ~C-j~ and you can’t
-  figure out why? ~(eq (key-binding "\n") 'unwanted-command)~ is the
-  assertion for you!
+- Are you getting obscure errors when trying to open /“.tex”/ files?
+  - Don’t despair! Just use ~(find-file "dummy.tex")~ as the assertion.
+- Did ~ox-html~ stop working due to some arcane misconfiguration?
+  - Just write an assertion that does an export and checks the result.
+- Does some random command suddenly bind itself to ~C-j~ and you can’t figure 
out why?
+  - ~(eq (key-binding "\n") 'unwanted-command)~ is the assertion for you!
 
 Finally, you can also use ~bug-hunter-file~ to hunt in other files.
 
 * 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
-Bug Hunter will be on Gelpa shortly. For now, do the following:
-1. Open the `bug-hunter.el` file.
-2. Issue  `M-x package-install-from-buffer`.
+The Bug Hunter is available from 
[[https://elpa.gnu.org/packages/bug-hunter.html][GNU Elpa]] to all Emacs 
versions since
+~24.1~. To install, just issue
+
+#+BEGIN_SRC text
+M-x package-install RET bug-hunter
+#+END_SRC