begin sensible README

This commit is contained in:
wikoF 2017-06-22 09:12:30 +02:00
parent 30a8149475
commit 57d969e5d4
1 changed files with 16 additions and 1 deletions

View File

@ -2,4 +2,19 @@
shell script to handle kanban file(s) in Markdown format
*WIP* ;-)
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.
The three possible list bullets `-*+` are used as indicators of
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
lists ("kanban" files) and of
the configuration file defining kanbans and some parameters.
In addition, it will display as "doing" each list item of the
pattern `- XX (MM-DD)` where `XX` are any characters, and
`MM-DD` corresponds to the current month and day.
*This feature currently is in beta testing.*