commit dbd9052ea97c36c0f687275fbeb870809be68cc4
from: Paul W. Rankin <rnkn@rnkn.xyz>
date: Mon Feb 01 07:24:21 2021 UTC

Improve README, add info about bug reports

commit - 578d0782c49366a9f5d0429fa49e978edc1170bf
commit + dbd9052ea97c36c0f687275fbeb870809be68cc4
blob - 2f5aa1239ba4d7a0a6bb811d72f8cf073190d756
blob + 9c59739b3c0843df0788bb339f594f672d4af0b5
--- README.md
+++ README.md
@@ -7,10 +7,9 @@ Side Notes
 Quickly display your quick side notes in quick side window.
 
 Side notes live in a plain text file, called `notes.txt` by default, in
-the current directory or any higher directory in the current hierarchy.
-i.e. When locating notes, we first look for a `notes.txt` file in the
-current directory, then one directory up, then two directories up, and
-so forth.
+the current directory or any parent directory (i.e. when locating notes,
+we first look in the current directory, then one directory up, then two
+directories up, and so forth.)
 
 Side notes are displayed in a side window with the command
 `side-notes-toggle-notes`.
@@ -22,20 +21,20 @@ To really mix things up, there's the user option
 display a separate notes file in a lower side window when the command
 `side-notes-toggle-notes` is prefixed with an argument (`C-u`).
 
-By default, having a notes file in any parent directory will locate that
+By default a notes file found in any parent directory will open that
 file rather than visit a non-existing file in the current directory, but
 you can override this by prefixing `side-notes-toggle-notes` with...
 
--  `C-u C-u` to force visiting `side-notes-file` within the current
+ - `C-u C-u` to force visiting `side-notes-file` within the current
    directory.
--  `C-u C-u C-u` to force visiting `side-notes-secondary-file` within
+ - `C-u C-u C-u` to force visiting `side-notes-secondary-file` within
    the current directory.
 
-Of course, you can use Markdown or Org Mode formatting by changing the
+Of course, you can use Markdown or Org Mode or whatever by changing the
 file extensions of `side-notes-file` and/or `side-notes-secondary-file`.
 
 For more information on how to change the way the side window is
-displayed, see `(info "(elisp) Side Windows")`
+displayed, see `(info "(elisp) Side Windows")`.
 
 
 Installation
@@ -46,5 +45,17 @@ your init file:
 
     (define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
 
+
+Bugs and Feature Requests
+-------------------------
+
+Send me an email (address in the package header). For bugs, please
+ensure you can reproduce with:
+
+    $ emacs -Q -l side-notes.el
+
+Known issues are tracked with `FIXME` comments in the source.
+
+
 [1]: https://stable.melpa.org/#/side-notes
 [2]: https://melpa.org/#/side-notes
blob - b5533e50a3e7b2a33f28fb2dce95a88d996bc851
blob + f07b624fd150ba38d40bf0949e597eead0089928
--- side-notes.el
+++ side-notes.el
@@ -31,10 +31,9 @@
 ;; Quickly display your quick side notes in quick side window.
 
 ;; Side notes live in a plain text file, called notes.txt by default, in
-;; the current directory or any higher directory in the current hierarchy.
-;; i.e. When locating notes, we first look for a notes.txt file in the
-;; current directory, then one directory up, then two directories up, and
-;; so forth.
+;; the current directory or any parent directory (i.e. when locating notes,
+;; we first look in the current directory, then one directory up, then two
+;; directories up, and so forth.)
 
 ;; Side notes are displayed in a side window with the command
 ;; side-notes-toggle-notes.
@@ -46,20 +45,20 @@
 ;; display a separate notes file in a lower side window when the command
 ;; side-notes-toggle-notes is prefixed with an argument (C-u).
 
-;; By default, having a notes file in any parent directory will locate that
+;; By default a notes file found in any parent directory will open that
 ;; file rather than visit a non-existing file in the current directory, but
 ;; you can override this by prefixing side-notes-toggle-notes with...
 
-;; -  C-u C-u to force visiting side-notes-file within the current
+;;  - C-u C-u to force visiting side-notes-file within the current
 ;;    directory.
-;; -  C-u C-u C-u to force visiting side-notes-secondary-file within
+;;  - C-u C-u C-u to force visiting side-notes-secondary-file within
 ;;    the current directory.
 
-;; Of course, you can use Markdown or Org Mode formatting by changing the
+;; Of course, you can use Markdown or Org Mode or whatever by changing the
 ;; file extensions of side-notes-file and/or side-notes-secondary-file.
 
 ;; For more information on how to change the way the side window is
-;; displayed, see (info "(elisp) Side Windows")
+;; displayed, see (info "(elisp) Side Windows").
 
 
 ;; Installation
@@ -70,6 +69,18 @@
 
 ;;     (define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
 
+
+;; Bugs and Feature Requests
+;; -------------------------
+
+;; Send me an email (address in the package header). For bugs, please
+;; ensure you can reproduce with:
+
+;;     $ emacs -Q -l side-notes.el
+
+;; Known issues are tracked with FIXME comments in the source.
+
+
 ;; [1]: https://stable.melpa.org/#/side-notes
 ;; [2]: https://melpa.org/#/side-notes