Marty/topen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Improve introduction reading flow
Some checks failed
website / build (push) Has been cancelled
Details
website / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Marty Oehme 2025-09-15 10:53:34 +02:00
parent 09d996eb15
commit 5724c8888d
Signed by: Marty
GPG key ID: 4E535BC19C61886E
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -8,20 +8,12 @@
A script without bells and whistles. A script without bells and whistles.
Focuses on letting you quickly: Focuses on letting you quickly:
- create notes for taskwarrior tasks - create new notes for taskwarrior tasks
- edit notes for taskwarrior tasks - edit existing notes for taskwarrior tasks
It does both by simply being invoked with `topen <task-id>`. It does both by simply being invoked with `topen <task-id>`.
Provide a taskwarrior task id or uuid and `topen` creates a new note file or lets Or it can be used directly from taskwarrior by being aliased in your `taskrc`:
you edit an existing one. Additionally it adds a small annotation to the task
to let you see that there exists a note file next time you view the task.
Should just work as-is without additional configuration in most modern taskwarrior setups.
Can be configured through environment variables or cli options, see below.
Can be used as-is with the `topen` command or directly from taskwarrior by being aliased in your `taskrc`:
```conf ```conf
alias.note=exec topen alias.note=exec topen
@ -30,8 +22,16 @@ alias.note=exec topen
And you can open any note with your usual taskwarrior workflow, And you can open any note with your usual taskwarrior workflow,
by doing `task note <id>`. by doing `task note <id>`.
Provide a taskwarrior task id or uuid and `topen` creates a new note file or lets
you edit an existing one. Additionally it adds a small annotation to the task
to let you see that there exists a note file next time you view the task.
That's all there is to it. That's all there is to it.
Everything should just work as-is without additional configuration in most modern taskwarrior setups.
But if you want, many settings can be configured through your taskrc file, environment variables, or cli options, see below.
## Installation ## Installation
You can install the script with your favorite python environment manager: You can install the script with your favorite python environment manager: