hrn 0.3.0

Manage plans (lists) and notes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# hrn

Yet another take on notes, plans (to-do lists), and even mind maps. But this
one is taylored specifically to my needs, so it is obviously the correct one.

## What is it?

`hrn`'s primary use case is editing plan files:

```
∙ This is my plan for the week
  ∙ some TODO
  … task in progress
    ✓ this is done
    ∙ another subtask
  𐄂 gave up on this
```

**NOTE:** `hrn` requires plan files to have a single top-level item.

`hrn` provides a terminal user interface that makes editing such files
extremely convenient. But it also adds some twists:

- such lists are trees, and so are directories of files - `hrn` lets you open a
  directory to edit multiple plan files in a single tree
- sometimes, you need more than a few words to keep track of something - every
  item can be linked to a notes file, which can be conveniently shown or edited
  with your favorite pager or editor
- focus is key - the view can be reduced to a subtree, to not get distracted by
  other tasks, or simply reclaim screen estate for what matters right now
- finding the right tasks to do can be half the work - the view mode can be
  switched to a [h-m-m][hmm]-inspired "mind map style" to help organize your
  thoughts

[hmm]: https://github.com/nadrad/h-m-m "h-m-m project page on Github"

## What it isn't

- a [zettelkasten][wpzk] - `hrn`'s focus is on the plan files, and links are
  only from plan items to notes, not vice versa, not between notes, and not
  between items
- a search engine - `hrn` never "reads" the notes files, so it also doesn't
  search them

[wpzk]: https://en.wikipedia.org/wiki/Zettelkasten "Zettelkasten on Wikipedia"

## Getting started

Basic usage along with the key bindings are described in the [man
page][hrn1html] ([source][hrn1]). The bindings are currently not configurable.

[hrn1html]: https://bitfehler.net/man/hrn.1.html
[hrn1]: https://git.sr.ht/~bitfehler/hrn/tree/master/item/man/hrn.1.scd

There is also a [cheat sheet][cspdf] ([source][cssrc]) for the key bindings.

[cspdf]: https://bitfehler.net/man/hrn-cheat-sheet.pdf
[cssrc]: https://git.sr.ht/~bitfehler/hrn/tree/master/item/man/cheat-sheet.typ

To get started, best start editing a single file:

    hrn todo.plan

## Contact

Feel free to send questions, patches, or other feedback to my [public
inbox][inbox].

[inbox]: https://lists.sr.ht/~bitfehler/public-inbox