kdheepak/taskwarrior-tui
1
0
Fork 0
mirror of https://github.com/kdheepak/taskwarrior-tui.git synced 2025-08-24 05:26:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update README.md 📚

Browse source
This commit is contained in:
Dheepak Krishnamurthy 2022-02-07 11:12:48 -07:00
parent 18b4634bdd
commit a9ff264e3b
1 changed files with 10 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -15,9 +15,10 @@ A Terminal User Interface for [Taskwarrior](https://taskwarrior.org/) that you d
### Features ### Features
- vim-like navigation - vim-like navigation
- colors based on taskwarrior - add, delete, complete, log tasks from TUI
- multiple selection - multiple selection
- tab completion - tab completion
- colors based on taskwarrior
### Showcase ### Showcase
@ -88,25 +89,22 @@ See the documentation for more information:
- <https://kdheepak.com/taskwarrior-tui/configuration/colors> - <https://kdheepak.com/taskwarrior-tui/configuration/colors>
- <https://kdheepak.com/taskwarrior-tui/configuration/advanced/> - <https://kdheepak.com/taskwarrior-tui/configuration/advanced/>
<details> Here is an example `.taskrc`
<summary>Here is an example <code>.taskrc</code></summary>
<pre class=".taskrc"><code>### taskwarrior configuration options
# taskwarrior&#39;s configuration ```.taskrc
### taskwarrior configuration options
# taskwarrior's configuration
data.location=.task data.location=.task
verbose=affected,blank,context,edit,header,footnote,label,new-id,project,special,sync,recur verbose=affected,blank,context,edit,header,footnote,label,new-id,project,special,sync,recur
uda.priority.values=H,M,,L uda.priority.values=H,M,,L
color.alternate= color.alternate=
# taskwarrior-tui reads color attributes from the following to display the same colors of tasks as the CLI # taskwarrior-tui reads color attributes from the following to display the same colors of tasks as the CLI
color.tagged=black on rgb444 color.tagged=black on rgb444
# Remove age, tags from task next report. # Remove age, tags from task next report.
# taskwarrior-tui reads the labels and columns from these options to display tasks the same way taskwarrior does # taskwarrior-tui reads the labels and columns from these options to display tasks the same way taskwarrior does
report.next.labels=ID,Active,Age,Deps,P,Project,Tag,Recur,S,Due,Until,Description,Urg report.next.labels=ID,Active,Age,Deps,P,Project,Tag,Recur,S,Due,Until,Description,Urg
report.next.columns=id,start.age,entry.age,depends,priority,project,tags,recur,scheduled.countdown,due.relative,until.remaining,description.truncated_count,urgency report.next.columns=id,start.age,entry.age,depends,priority,project,tags,recur,scheduled.countdown,due.relative,until.remaining,description.truncated_count,urgency
report.next.filter=(status:pending or status:waiting) page:limit report.next.filter=(status:pending or status:waiting) page:limit
@ -116,14 +114,11 @@ report.next.filter=(status:pending or status:waiting) page:limit
uda.taskwarrior-tui.keyconfig.done=x uda.taskwarrior-tui.keyconfig.done=x
uda.taskwarrior-tui.keyconfig.delete=d uda.taskwarrior-tui.keyconfig.delete=d
uda.taskwarrior-tui.shortcuts.0=~/local/bin/task-sync.sh uda.taskwarrior-tui.shortcuts.0=~/local/bin/task-sync.sh
uda.taskwarrior-tui.report.next.filter=(status:pending or status:waiting)</code></pre> uda.taskwarrior-tui.report.next.filter=(status:pending or status:waiting)
```
<p><code>taskwarrior-tui</code> parses the output of <code>task `taskwarrior-tui` parses the output of `task show` to get configuration data.
show</code> to get configuration data. This allows This allows `taskwarrior-tui` to use the same defaults as `taskwarrior` and configure additional options as required.
<code>taskwarrior-tui</code> to use the same defaults as
<code>taskwarrior</code> and configure additional options as
required.</p>
</details>
### References / Resources ### References / Resources