aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul W. Rankin <pwr@bydasein.com>2021-02-01 17:24:21 +1000
committerPaul W. Rankin <pwr@bydasein.com>2021-02-01 17:24:21 +1000
commit9ce87d0a56ac3fd959efda8a566262cb39d4546a (patch)
tree2b04039f6199925d38aa2fac5db0833f0a9075d0
parentda4def717abe1c7ee7b90ba7f7a74df1302a2e89 (diff)
downloadside-notes-9ce87d0a56ac3fd959efda8a566262cb39d4546a.zip
Improve README, add info about bug reports
-rw-r--r--README.md29
-rw-r--r--side-notes.el29
2 files changed, 40 insertions, 18 deletions
diff --git a/README.md b/README.md
index 2f5aa12..9c59739 100644
--- a/README.md
+++ b/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
diff --git a/side-notes.el b/side-notes.el
index b5533e5..f07b624 100644
--- a/side-notes.el
+++ b/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