#### install

`cargo install voidmap`

if you don't have cargo, an easy way to get and manage it is [via
rustup](https://www.rustup.rs/). Ensure that `~/.cargo/bin` is in your
`$PATH` afterward, so that you can use the `rustup` and `cargo`
commands.

If you get errors along the lines of
`` error: the `?' operator is not stable `` then you need to update your
rust compiler. If you installed rust with rustup, this can be
accomplished with `rustup update`. Requires a recent stable rust
compiler, `1.14.0` or higher is recommended. This can be checked with
`rustc --version`. If you have installed rust with rustup, but you have
an old version, there may be an older version previously installed on
your system. Verify that `which cargo` outputs a path that belongs to
your `.cargo/bin` directory.

#### startup

`void`

this attempts to use `$HOME/.void.db` as a storage file. if you'd like
to specify a different storage file:

`void [/path/to/savefile]`

#### basic node creation

1.  `C-n`: create a new node (`C-x` means `Ctrl+x`)
2.  Type some text to populate it (empty nodes are automatically deleted
    when unselected)
3.  `Tab`: create a child node
4.  `Enter`: create a sibling node

#### navigation

1.  `C-n`: create another new node and add text
2.  left/right arrow jump between nodes
3.  `C-u`: search by typing text and hitting enter. repeat to show next
    result.
4.  `C-f`: search for visible nodes by entering its first letter
5.  `<letter of match>` letters will show up next to options
6.  `<A-p>`: Select parent of current node.

#### scopes

1.  make a deep subtree by hitting tab and populating text on children
    nodes
2.  select the middle of the deep subtree with arrows or the mouse
3.  `C-t`: collapse subtree
4.  `C-w`: drill-down view into the collapsed subtree
5.  `C-p`: arrange new view in a non-overlapping way
6.  `C-q`: pop-up to previous view

#### tasks

1.  create a tree with a node that contains the text `#task`
2.  give it several children, they are implicitly also tasks
3.  give the children different priorities with `#prio=<n>` in their
    name
4.  `C-v`: randomly select a subtask based on priority weights
5.  `C-a`: mark the task as completed, the graph at the top will show
    the daily completed tasks for the last week
6.  select a node that has some complete children, and some incomplete
    children
7.  `C-h`: hide completed children

#### rearrangement

1.  drag one subtree over another with the mouse
2.  drag a child node away from any other nodes to detach it from its
    parent
3.  drag it back to a new parent