summaryrefslogtreecommitdiff
path: root/jt.md
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers+gitlab@digital-scurf.org>2020-09-12 16:16:32 +0000
committerDaniel Silverstone <dsilvers+gitlab@digital-scurf.org>2020-09-12 16:16:32 +0000
commit9243b189a1a12bc0ed819d59cd3cbe9ce5d37c2a (patch)
tree1f3a846448a2fcb943e805c58ac371ee0ea59bb7 /jt.md
parentbddb592c4cb89e76796b17dd5bed823eba7e2b0e (diff)
parentd4e8b0409d6bc99522a6a995349e9779b9c9cd62 (diff)
downloadjt2-9243b189a1a12bc0ed819d59cd3cbe9ce5d37c2a.tar.gz
Merge branch 'init' into 'master'
feat: create and initialise a new journal Closes #1 See merge request larswirzenius/jt!2
Diffstat (limited to 'jt.md')
-rw-r--r--jt.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/jt.md b/jt.md
index c765d03..c8beace 100644
--- a/jt.md
+++ b/jt.md
@@ -23,17 +23,48 @@ journal for the user, and a new journal entry. The entry is a draft
until it's finished.
~~~sh
-$ jt create ~/Journal default "My private journal"
+$ jt init ~/Journal default "My private journal"
$ jt new --tag meta --tag journalling "My first journal entry"
... # text editor is opened so the new entry can be written
$ jt finish
~~~
+# Acceptance criteria and their verification
+
+This chapter defines detailed acceptance criteria and how they're
+verified using *scenarios* for the [Subplot][] tool.
+
+[Subplot]: https://subplot.liw.fi/
+
+## Create a new local journal repository
+
+`jt` works on a local repository, and it can be created an initialised
+using the tool.
+
+~~~scenario
+when I run jt init jrnl default "My test journal"
+then program finished successfully
+and directory jrnl exists
+
+when I run jt is-journal jrnl
+then program finished successfully
+
+when I run jt is-journal bogus
+then exit code is non-zero
+~~~
+
+
---
title: "jt&mdash;a journalling tool"
author:
- Lars Wirzenius
- Daniel Silverstone
+bindings:
+- jt.yaml
+- runcmd.yaml
+functions:
+- jt.py
+- runcmd.py
...