From 93d9717a640528c87f92129bffbf9164e878108e Mon Sep 17 00:00:00 2001 From: Scott Worley Date: Wed, 25 Oct 2023 01:11:33 -0700 Subject: [PATCH] README --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..91641a3 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Vopamoi + +A to-do organizer + +* vi-style keyboard interface +* Runs in a web browser + * Uses localStorage for storage (private!) +* Has standard GTD-flavored todo-organizer features: + * task states: todo, done, waiting, someday-maybe, cancelled, deleted + * tags + * contexts (just use tags) + * projects (use another task's name as a tag) + * priority/ordering + * task notes + * undo + +(Replication between instances is not yet implemented.) + +#### Command mode default key bindings + +| Key | Function | +| :-----: | ----------------------------------- | +| h j k l | Move cursor over tasks | +| tab | Move cursor over tags | +| ^e ^y | Move view | +| H L | Move task | +| T | Top priority (move task to top) | +| 0-9 | vi-style prefix repeat count | +| G | Go to task by number | +| n | New task (enter edit mode) | +| e | Edit task (enter edit mode) | +| E | Edit task notes (enter edit mode) | +| t | Add Tag (enter edit mode) | +| x | Remove tag | +| d | Set task state: Done | +| sm | Set task state: Someday-Maybe | +| w | Set task state: Waiting | +| q | Set task state: Todo ('queued') | +| C | Set task state: Cancelled | +| X | Set task state: Deleted | +| u | Undo | +| r | Redo | +| va | View All tasks | +| vv | Reset view | +| vd | View Done tasks | +| vsm | View Someday-Maybe tasks | +| vw | View Waiting tasks | +| vq | View Todo ('queued') tasks | +| vC | View Cancelled tasks | +| vX | View Deleted tasks | +| vt | View tasks with this Tag | +| vT | Reset tag view filter (reverses vt) | +| vu vi | View Untagged tasks ('inbox') | +| vp | View Projects | +| vD | Toggle Dark mode | + +#### Edit mode default key bindings + +| Key | Context | Function | +| :-----: | :-------: | ------------------------------- | +| escape | * | Cancel editing | +| enter | task, tag | Finish editing | +| ^enter | notes | Finish editing | +| ^enter | new-task | Finish editing, bottom priority | -- 2.44.1