[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/bug-hunter 8f89191 03/95: Write readme

From: Stefan Monnier
Subject: [elpa] externals/bug-hunter 8f89191 03/95: Write readme
Date: Fri, 27 Nov 2020 22:06:46 -0500 (EST)

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

    Write readme
 README.md  |   2 --
 README.org |  29 +++++++++++++++++++++++++++++
 hunter.png | Bin 0 -> 1007 bytes
 3 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
deleted file mode 100644
index 13e610f..0000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# bisect-lisp-file
-Bisect your Emacs init file to track down issues.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..6feea09
--- /dev/null
+++ b/README.org
@@ -0,0 +1,29 @@
+#+OPTIONS: toc:nil num:nil
+#+TITLE: Bug Hunter [[file:hunter.png]] 
+~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 (test-the-misbehaving-feature) 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/names.html][GNU Elpa]]. To install, issue 
+#+BEGIN_SRC text
+M-x package-install RET bug-hunter
diff --git a/hunter.png b/hunter.png
new file mode 100644
index 0000000..e365dd3
Binary files /dev/null and b/hunter.png differ

reply via email to

[Prev in Thread] Current Thread [Next in Thread]