clarify README (cosmetics)

This commit is contained in:
Yargo Bonetti 2019-12-11 21:23:11 +01:00
parent 96e46513e5
commit f9e4f65579
1 changed files with 17 additions and 16 deletions

View File

@ -3,12 +3,12 @@
This shell script provides an interactive command line
interface for manipulating files with Markdown formatted lists.
Each list item corresponds to a card of personal kanban system.
Each list item corresponds to a card of a simple kanban system.
The three possible list bullets `-*+` are used as indicators of
status wait/backlog, doing, and done/archived.
status "wait/backlog", "doing", and "done/archived".
The script permits displaying and status changes of the items,
addition of a new item as "waiting", direct edition of the
addition of new "waiting" items, direct edition of the
lists ("kanban" files) and of the configuration file defining
kanbans and some script parameters.
@ -47,7 +47,7 @@ then also the configuration can be displayed by entering `c`.
- `do` N : change card to "doing/active" status
- `done` N : change card to "archive/done" status
- `wait` N : change card to "waiting/backlog" status
- `n` : add a new item/card to the target kanban (only one line of text)
- `n` : add a new item/card to the target kanban (only one line of text);
content may be given on the same line, separated by whitespace
- `k` : define target kanban file (for direct edition, and new items)
- `ek` : directly edit the target kanban file with the text editor
@ -69,21 +69,20 @@ more than one "kanban file" -- in particular, they will all change
status (doing/waiting/done) together.
The `d` command will not only display items with a preceding `*` but
also those with a pattern of `.*(MM-DD)*` where `.` may be any one
of `-*+` and `*` means any sequence of characters and `MM` is the
current month and `DD` the current day. This permits to e.g use one
also those with a pattern of `(MM-DD)` anywhere after preceding `-*+` characters, with `MM` being the
current month and `DD` the current day. This permits to use a
"kanban file" as a calendar; in that case it should be given as last
`kanban` entry, to not fill the screen only with calendar entries when
`kanban` entry, to prevent filling of the screen with calendar entries when
using any of the `d w a` commands (see also example below).
## Configuration
The script expects a configuration file named by the environment
variable `$CLIKANCONF` or `$HOME/.clikanconf` as default.
If there isn't any, the script will generate a new one, populated
variable `$CLIKANCONF` or (if undefined) `$HOME/.clikanconf` by default.
If there isn't any, the script generates a new one, populated
with all possible parameters at reasonable default values, and
will also create an item list ("kanban file") with the name
`$HOME/clikanban.md` with some dummy entries.
also creates an item list ("kanban file") with the name
`$HOME/clikanban.md` containing some dummy entries.
Please see the source or the generated configuration file for
information about possible settings!
@ -94,7 +93,7 @@ something went wrong with the configuration file.*
In addition, it uses the contents of `$VISUAL` or `$EDITOR`
when needing to launch a text editor, or `ed` as default.
*(Yay, ed !)*
*(Because, what else!?)*
## Example
@ -134,7 +133,7 @@ Now let's assume we know everything, so card 1 is done:
waiting/todo/backlog
1: improve clikan
We've seen there is waiting work, so let's do it:
Obviously there is work waiting, so let's do it:
|< do 1
@ -203,11 +202,13 @@ The new card has been added to the waiting/backlog list:
waiting/todo/backlog
1: give feedback to clikan developer
We could also have given the card content as direct argument, by typing `n give feedback...` at the prompt.
Just hitting RETURN at the prompt shows the help/usage page:
|<
./clikan.sh : command line kanban
(2017-06-22 Y.Bonetti)
(2019-12-11/HB9KNS)
configuration file: /home/username/.clikanconf
for help about commands, just hit RETURN
to show configuration, enter 'c'
@ -221,7 +222,7 @@ We want to see the configuration, then quit:
maxshow=15
configfile contents:
# configuration file for ./clikan.sh
# (autogenerated at Don Jun 22 17:18:26 CEST 2017)
# (autogenerated at Wed Dec 11 17:18:26 CEST 2019)
# file name can be defined by env.var CLIKANCONF
#
# prompt is displayed when waiting for command