mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-06-26 10:54:26 +02:00
Consolidate in-repo documentation (#3143)
* move doc/misc to top level, add READMEs * Move docs -> doc/devel This also consolidates the _three_ documents describing (differently) how to build Taskwarrior into a signle document.
This commit is contained in:
parent
3248437326
commit
971b229a4b
43 changed files with 141 additions and 681 deletions
3
misc/README.md
Normal file
3
misc/README.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# misc/
|
||||
|
||||
This directory contains bits and bobs that do not belong elsewhere.
|
28
misc/themes/README
Normal file
28
misc/themes/README
Normal file
|
@ -0,0 +1,28 @@
|
|||
Themes
|
||||
|
||||
These scripts are a way to generate a little sample data, and show the color
|
||||
themes. It is not intended for general use.
|
||||
|
||||
To generate samples of themes, first execute the 'setup' script to generate the
|
||||
sample data. Note that this data may need to be tweaked to include qualities
|
||||
that need to be illustrated in theme sample.
|
||||
|
||||
Using a dark-background terminal (black recommended), run the following:
|
||||
|
||||
run.dark
|
||||
|
||||
Using a light-background terminal, run the following:
|
||||
|
||||
run.light
|
||||
|
||||
Using a solarized dark terminal, run the following:
|
||||
|
||||
run.solar.dark
|
||||
|
||||
Using a solarized light terminal, run the following:
|
||||
|
||||
run.solar.light
|
||||
|
||||
Note that for the solarized themes, the terminal color palette needs to be set
|
||||
to specific colors.
|
||||
|
36
misc/themes/run.dark
Executable file
36
misc/themes/run.dark
Executable file
|
@ -0,0 +1,36 @@
|
|||
#!/bin/bash
|
||||
|
||||
for theme in $PWD/../../rc/dark-16.theme \
|
||||
$PWD/../../rc/dark-256.theme \
|
||||
$PWD/../../rc/dark-blue-256.theme \
|
||||
$PWD/../../rc/dark-gray-256.theme \
|
||||
$PWD/../../rc/dark-gray-blue-256.theme \
|
||||
$PWD/../../rc/dark-green-256.theme \
|
||||
$PWD/../../rc/dark-red-256.theme \
|
||||
$PWD/../../rc/dark-violets-256.theme \
|
||||
$PWD/../../rc/dark-yellow-green.theme
|
||||
do
|
||||
cat <<EOF >x
|
||||
data.location=.
|
||||
confirmation=off
|
||||
detection=off
|
||||
_forcecolor=on
|
||||
default.height=24
|
||||
verbose=off
|
||||
include $theme
|
||||
EOF
|
||||
|
||||
echo "--- $theme -----------------------------------------------------"
|
||||
echo '$ task color legend'
|
||||
task rc:x color legend
|
||||
echo '$ task list'
|
||||
task rc:x list
|
||||
echo '$ task summary'
|
||||
task rc:x summary
|
||||
echo '$ task ghistory'
|
||||
task rc:x ghistory
|
||||
echo '$ task calendar'
|
||||
task rc:x calendar
|
||||
echo '$ task burndown.daily'
|
||||
task rc:x burndown.daily
|
||||
done
|
24
misc/themes/run.default
Executable file
24
misc/themes/run.default
Executable file
|
@ -0,0 +1,24 @@
|
|||
#!/bin/bash
|
||||
|
||||
cat <<EOF >x
|
||||
data.location=.
|
||||
confirmation=off
|
||||
detection=off
|
||||
_forcecolor=on
|
||||
default.height=24
|
||||
verbose=off
|
||||
EOF
|
||||
|
||||
echo "--- DEFAULT -----------------------------------------------------"
|
||||
echo '$ task color legend'
|
||||
task rc:x color legend
|
||||
echo '$ task list'
|
||||
task rc:x list
|
||||
echo '$ task summary'
|
||||
task rc:x summary
|
||||
echo '$ task ghistory'
|
||||
task rc:x ghistory
|
||||
echo '$ task calendar'
|
||||
task rc:x calendar
|
||||
echo '$ task burndown.daily'
|
||||
task rc:x burndown.daily
|
29
misc/themes/run.light
Executable file
29
misc/themes/run.light
Executable file
|
@ -0,0 +1,29 @@
|
|||
#!/bin/bash
|
||||
|
||||
for theme in $PWD/../../rc/light-16.theme \
|
||||
$PWD/../../rc/light-256.theme
|
||||
do
|
||||
cat <<EOF >x
|
||||
data.location=.
|
||||
confirmation=off
|
||||
detection=off
|
||||
_forcecolor=on
|
||||
default.height=24
|
||||
verbose=off
|
||||
include $theme
|
||||
EOF
|
||||
|
||||
echo "--- $theme -----------------------------------------------------"
|
||||
echo '$ task color legend'
|
||||
task rc:x color legend
|
||||
echo '$ task list'
|
||||
task rc:x list
|
||||
echo '$ task summary'
|
||||
task rc:x summary
|
||||
echo '$ task ghistory'
|
||||
task rc:x ghistory
|
||||
echo '$ task calendar'
|
||||
task rc:x calendar
|
||||
echo '$ task burndown.daily'
|
||||
task rc:x burndown.daily
|
||||
done
|
28
misc/themes/run.solar.dark
Executable file
28
misc/themes/run.solar.dark
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/bin/bash
|
||||
|
||||
for theme in $PWD/../../rc/solarized-dark-256.theme
|
||||
do
|
||||
cat <<EOF >x
|
||||
data.location=.
|
||||
confirmation=off
|
||||
detection=off
|
||||
_forcecolor=on
|
||||
default.height=24
|
||||
verbose=off
|
||||
include $theme
|
||||
EOF
|
||||
|
||||
echo "--- $theme -----------------------------------------------------"
|
||||
echo '$ task color legend'
|
||||
task rc:x color legend
|
||||
echo '$ task list'
|
||||
task rc:x list
|
||||
echo '$ task summary'
|
||||
task rc:x summary
|
||||
echo '$ task ghistory'
|
||||
task rc:x ghistory
|
||||
echo '$ task calendar'
|
||||
task rc:x calendar
|
||||
echo '$ task burndown.daily'
|
||||
task rc:x burndown.daily
|
||||
done
|
28
misc/themes/run.solar.light
Executable file
28
misc/themes/run.solar.light
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/bin/bash
|
||||
|
||||
for theme in $PWD/../../rc/solarized-light-256.theme
|
||||
do
|
||||
cat <<EOF >x
|
||||
data.location=.
|
||||
confirmation=off
|
||||
detection=off
|
||||
_forcecolor=on
|
||||
default.height=24
|
||||
verbose=off
|
||||
include $theme
|
||||
EOF
|
||||
|
||||
echo "--- $theme -----------------------------------------------------"
|
||||
echo '$ task color legend'
|
||||
task rc:x color legend
|
||||
echo '$ task list'
|
||||
task rc:x list
|
||||
echo '$ task summary'
|
||||
task rc:x summary
|
||||
echo '$ task ghistory'
|
||||
task rc:x ghistory
|
||||
echo '$ task calendar'
|
||||
task rc:x calendar
|
||||
echo '$ task burndown.daily'
|
||||
task rc:x burndown.daily
|
||||
done
|
33
misc/themes/setup
Executable file
33
misc/themes/setup
Executable file
|
@ -0,0 +1,33 @@
|
|||
rm pending.data completed.data undo.data x
|
||||
|
||||
cat <<EOF >>x
|
||||
|
||||
data.location=.
|
||||
confirmation=off
|
||||
_forcecolor=on
|
||||
EOF
|
||||
|
||||
task rc:x add Ordinary task
|
||||
task rc:x add Started task
|
||||
task rc:x 2 start
|
||||
task rc:x add High priority task pri:H
|
||||
task rc:x add Medium priority task pri:M
|
||||
task rc:x add Low priority task pri:L
|
||||
task rc:x add Household task project:Home
|
||||
task rc:x add Outdoor task project:Garden
|
||||
task rc:x add Overdue task due:yesterday
|
||||
task rc:x add Due task due:tomorrow
|
||||
task rc:x add Not yet due tasks due:eom
|
||||
task rc:x add Recurring task due:eom recur:monthly
|
||||
task rc:x add Tagged task +tag1
|
||||
task rc:x add Blocking task
|
||||
task rc:x add Dependent task
|
||||
|
||||
task rc:x log Completed_1 project:Garden
|
||||
task rc:x log Completed_2 project:Garden
|
||||
task rc:x log Completed_3 project:Home
|
||||
task rc:x add Deleted_1
|
||||
|
||||
task rc:x 14 mod depends:13
|
||||
task rc:x 15 delete
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue