diff --git a/README.md b/README.md index c3edcff..6fd1e67 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ # Denote -The successor to usls: . FOR -PRIVATE USE. +Take notes using a strict file-naming convention. Denote does not do +anything else: + +- Want to search your notes? Use `M-x grep`, `M-x find-name-dired`, + `M-x consult-find`, `M-x consult-grep`, and so on. + +- Want to quickly jump to the directory of your notes? Visit it with + `M-x find-file RET path/to/notes` and then make a bookmark with `M-x + bookmark-set`. Access bookmarks with `M-x bookmark-jump`, `M-x + consult-buffer`, and the like. And/or treat your notes as a project + with the built-in project.el. + +- Narrow the list of notes? Do it from the completion UI and export the + results with `embark` (or equivalent). To achieve the same in Dired, + do `M-x dired-mark-files-regexp RET type-regexp-here RET t k`. The `t + k` will toggle the match so that it marks all files that do not match + the regexp and `k` will remove them from the buffer (restore them by + reverting the buffer). + +- Create links between notes? Use Org's standard linking facility. + +You get the idea: Denote is a small part of an existing toolkit. Think +of it as an opinionated template for `org-capture` (it can be integrated +in `org-capture-templates`, though it can work without that mechanism). + +* * * + +This is successor to usls: , which +I had been using for more than a year. Denote is intended for private +use, until I eventually turn it into a package that others can use. As +such, there is no manual for the time being and the code may change +considerably.