diff options
Diffstat (limited to 'yarns/020-basic-workflow.yarn')
| -rw-r--r-- | yarns/020-basic-workflow.yarn | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/yarns/020-basic-workflow.yarn b/yarns/020-basic-workflow.yarn new file mode 100644 index 0000000..2572076 --- /dev/null +++ b/yarns/020-basic-workflow.yarn @@ -0,0 +1,26 @@ +Basic Workflow +============== + +This chapter explains the basic workflow for adding notes. + +Notes are first created as drafts. Normally, when a draft is created, +`jt` invokes the user's preferred editor (`$VISUAL` or `$EDITOR`) on +the draft file. When the user is finished, they exit their editor and +run `jt finish`. The test suite is rigged so that the editor isn't +invoked, because it'd be difficult to control the editor. + + SCENARIO add a simple note + GIVEN an empty journal in SRC + AND the time is 2014-11-22 17:30:45 + WHEN I run jt new TITLE + THEN file SRC/drafts/0.mdwn exists + AND file SRC/drafts/0.mdwn matches title="TITLE" + +This is where the user would normally use their editor to edit the +draft, and exit the editor when done. + + WHEN I run jt finish + THEN file SRC/drafts/0.mdwn doesn't exist + AND file SRC/notes/2014/11/22/title.mdwn exists + +This is how you create a note, in the simplest case. |