From a9ff264e3bd355d0a2ea3d662c19d40f14c66d35 Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Mon, 7 Feb 2022 11:12:48 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20Update=20README.md=20=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index af63eec..59d669c 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ A Terminal User Interface for [Taskwarrior](https://taskwarrior.org/) that you d ### Features - vim-like navigation -- colors based on taskwarrior +- add, delete, complete, log tasks from TUI - multiple selection - tab completion +- colors based on taskwarrior ### Showcase @@ -88,25 +89,22 @@ See the documentation for more information: - - -
-Here is an example .taskrc -
### taskwarrior configuration options
+Here is an example `.taskrc`
 
-# taskwarrior's configuration
+```.taskrc
+### taskwarrior configuration options
 
+# taskwarrior's configuration
 data.location=.task
 verbose=affected,blank,context,edit,header,footnote,label,new-id,project,special,sync,recur
 uda.priority.values=H,M,,L
 color.alternate=
 
 # taskwarrior-tui reads color attributes from the following to display the same colors of tasks as the CLI
-
 color.tagged=black on rgb444
 
 # 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
-
 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.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.delete=d
 uda.taskwarrior-tui.shortcuts.0=~/local/bin/task-sync.sh
-uda.taskwarrior-tui.report.next.filter=(status:pending or status:waiting)
+uda.taskwarrior-tui.report.next.filter=(status:pending or status:waiting) +``` -

taskwarrior-tui parses the output of task -show to get configuration data. This allows -taskwarrior-tui to use the same defaults as -taskwarrior and configure additional options as -required.

-
+`taskwarrior-tui` parses the output of `task show` to get configuration data. +This allows `taskwarrior-tui` to use the same defaults as `taskwarrior` and configure additional options as required. ### References / Resources