branch: externals/denote
commit de4da02d1d6870bb0d275c1979ef49df5c94040c
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Expand overview to remark Denote's use beside "notes"
---
README.md | 6 ++++++
README.org | 17 +++++++++++++++--
denote.el | 25 +++++++++++++++++++------
3 files changed, 40 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 9938bf8633..63bf6e457d 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,12 @@ about, without reference to any other metadata. Denote
basically
streamlines the creation of such files while providing facilities to
link between them.
+Denote's file-naming scheme is not limited to "notes". It can be used
+for all types of file, including those that are not editable in Emacs,
+such as videos. Naming files in a constistent way makes their
+filtering and retrieval considerably easier. Denote provides relevant
+facilities to rename files, regardless of file type.
+
[Watch the video demo that was produced before version 0.1.0 of the
package](https://protesilaos.com/codelog/2022-06-18-denote-demo/).
diff --git a/README.org b/README.org
index 7fa999f94f..6d7d82cbb4 100644
--- a/README.org
+++ b/README.org
@@ -72,8 +72,21 @@ modify this GNU manual.”
:END:
Denote aims to be a simple-to-use, focused-in-scope, and effective
-note-taking tool for Emacs. It is based on the following core design
-principles:
+note-taking tool for Emacs.
+
+Denote is based on the idea that notes should follow a predictable and
+descriptive file-naming scheme. The file name must offer a clear
+indication of what the note is about, without reference to any other
+metadata. Denote basically streamlines the creation of such files
+while providing facilities to link between them.
+
+Denote's file-naming scheme is not limited to "notes". It can be used
+for all types of file, including those that are not editable in Emacs,
+such as videos. Naming files in a constistent way makes their
+filtering and retrieval considerably easier. Denote provides relevant
+facilities to rename files, regardless of file type.
+
+Denote is based on the following core design principles:
+ Predictability :: File names must follow a consistent and descriptive
naming convention ([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The
file-naming scheme]]). The file name alone
diff --git a/denote.el b/denote.el
index 1b437b7415..40339a4fa7 100644
--- a/denote.el
+++ b/denote.el
@@ -25,13 +25,26 @@
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
-;;
+
;; Denote aims to be a simple-to-use, focused-in-scope, and effective
-;; note-taking tool for Emacs. The manual describes all the
-;; technicalities about the file-naming scheme, points of entry to
-;; creating new notes, commands to check links between notes, and more:
-;; <https://protesilaos.com/emacs/denote>. If you have the info manual
-;; available, evaluate:
+;; note-taking tool for Emacs.
+;;
+;; Denote is based on the idea that notes should follow a predictable and
+;; descriptive file-naming scheme. The file name must offer a clear
+;; indication of what the note is about, without reference to any other
+;; metadata. Denote basically streamlines the creation of such files
+;; while providing facilities to link between them.
+;;
+;; Denote's file-naming scheme is not limited to "notes". It can be used
+;; for all types of file, including those that are not editable in Emacs,
+;; such as videos. Naming files in a constistent way makes their
+;; filtering and retrieval considerably easier. Denote provides relevant
+;; facilities to rename files, regardless of file type.
+;;
+;; The manual describes all the technicalities about the file-naming
+;; scheme, points of entry to creating new notes, commands to check
+;; links between notes, and more: ;; <https://protesilaos.com/emacs/denote>.
+;; If you have the info manual available, evaluate:
;;
;; (info "(denote) Top")
;;
