Skip to content

Commit

Permalink
docs: update README for v0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dhth committed Jul 26, 2024
1 parent 1b6a9e3 commit ebb4165
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 56 deletions.
117 changes: 62 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,10 @@
`omm` (stands for "on-my-mind") is a keyboard-driven task manager for the
command line.

`omm` is intended for those who need to frequently rearrange tasks in their
to-do list. It lets you move any item to the top of the list, add tasks at
specific positions, and adjust task priorities up or down, all via one or two
keypresses.

![Usage](https://tools.dhruvs.space/images/omm/omm.gif)

[source video](https://www.youtube.com/watch?v=_VnvgqVdU20)
[source video](https://www.youtube.com/watch?v=iB_PHc92wgY)

🤔 Motivation
---
Expand Down Expand Up @@ -59,9 +55,9 @@ omm guide

### TUI

`omm`'s TUI is comprised of several panes: 3 lists (for active and archived
tasks, and one for task bookmarks), a context pane, and a task entry/update
pane.
`omm`'s TUI is comprised of several views: 4 lists (for active and archived
tasks, one for task bookmarks, and one for prefix selection), a context pane, a
task details pane, and a task entry/update pane.

#### Active Tasks List

Expand All @@ -85,8 +81,6 @@ tasks list. It's more for historical reference, but you can also unarchive a
task and put it back in the active list, if you need to. You can also
permanently delete tasks from here.

![active-tasks](https://tools.dhruvs.space/images/omm/omm-archived-tasks-1.png)

#### Context Pane

For tasks that need more details that you can fit in a one line summary, there
Expand All @@ -99,7 +93,10 @@ is chosen based on the following look ups:
- $EDITOR/$VISUAL
- `vi` (fallback)

![active-tasks](https://tools.dhruvs.space/images/omm/omm-context-1.png)
#### Task Details Pane

The Task Details pane lets you see all details for a task in a single scrollable
pane.

**[`^ back to top ^`](#omm)**

Expand Down Expand Up @@ -201,50 +198,60 @@ omm tasks
⌨️ Keymaps
---

```text
General
q/esc/ctrl+c go back
Q quit from anywhere
Active/Archived Tasks List
j/↓ move cursor down
k/↑ move cursor up
h go to previous page
l go to next page
g go to the top
G go to the end
tab move between lists
C toggle showing context
d toggle Task Details pane
b open task bookmarks list
B open all bookmarks added to current task
c update context for a task
ctrl+d archive/unarchive task
ctrl+x delete task
ctrl+r reload task lists
y copy selected task's context to system clipboard
v toggle between compact and spacious view
Active Tasks List
q/esc/ctrl+c quit
o/a add task below cursor
O add task above cursor
I add task at the top
A add task at the end
u update task summary
⏎ move task to the top
[2-9] move task at index [x] to top (only in compact view)
J move task one position down
K move task one position up
Task Details Pane
h/l move backwards/forwards when in the task details view
y copy selected task's context to system clipboard
B open all bookmarks added to current task
Task Bookmarks List
⏎ open URL in browser
```
### General

q/esc/ctrl+c go back
Q quit from anywhere

### Active/Archived Tasks List

j/↓ move cursor down
k/↑ move cursor up
h go to previous page
l go to next page
g go to the top
G go to the end
tab move between lists
C toggle showing context
d toggle Task Details pane
b open Task Bookmarks list
B open all bookmarks added to current task
c update context for a task
ctrl+d archive/unarchive task
ctrl+x delete task
ctrl+r reload task lists
/ filter list by task prefix
ctrl+p filter by prefix via the prefix selection list
y copy selected task's context to system clipboard
v toggle between compact and spacious view

### Active Tasks List

q/esc/ctrl+c quit
o/a add task below cursor
O add task above cursor
I add task at the top
A add task at the end
u update task summary
⏎ move task to the top
E move task to the end
J move task one position down
K move task one position up

### Task Creation/Update Pane

⏎ submit task summary
ctrl+p choose/change prefix via the prefix selection list

### Task Details Pane

h/←/→/l move backwards/forwards when in the task details view
y copy current task's context to system clipboard
B open all bookmarks added to current task

### Task Bookmarks List

⏎ open URL in browser

Acknowledgements
---
Expand Down
2 changes: 2 additions & 0 deletions cmd/assets/updates.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
• 🆕 Markdown in task context is rendered with syntax highlighting
• 🔄 Task Lists in "compact" mode show more than 9 tasks at a time, when
maximised
• ❌ Keymaps ([2-9]) for the Active Tasks list to move task at a specific index
to the top
• 🆕 Task Lists in "compact" mode highlight prefixes
• 🆕 Tasks Lists can be filtered using "/" 🄶
• 🆕 A quick filter based on task prefixes can be applied using "ctrl+p" 🄶
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ Error: %s`, author, repoIssuesUrl, guideErr)
ListDensity: ui.Compact,
TaskListColor: taskListColor,
ArchivedTaskListColor: archivedTaskListColor,
TaskListTitle: taskListTitle,
TaskListTitle: "omm guide",
TextEditorCmd: strings.Fields(editorCmd),
ShowContext: true,
Guide: true,
Expand Down

0 comments on commit ebb4165

Please sign in to comment.