summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2020-06-13 08:13:20 +0300
committerLars Wirzenius <liw@liw.fi>2020-07-13 09:52:45 +0300
commit79173399be37d69ab35afa79c4345d81591a8916 (patch)
treea287d3d75b1da4fee4bed415901adfd7d066e1e4
parent15d005871da34bee7622d4e65afe41acae95c52e (diff)
downloadjt2-79173399be37d69ab35afa79c4345d81591a8916.tar.gz
doc: write introduction to a jt subplot
-rw-r--r--jt.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/jt.md b/jt.md
index 58e591c..c765d03 100644
--- a/jt.md
+++ b/jt.md
@@ -1,3 +1,36 @@
+# Introduction
+
+The **jt** software (short for "journalling tool") is a helper for
+maintaining a journal or personal knowledge base. It has been written
+for the personal use of its authors, but might be useful for others.
+
+The guiding principle for jt is that having longevity for one's data
+and complete control over it are crucial. Because of these, the
+approach taken by jt is to build a static web site from source files
+stored in a version control system. The files will be edited with a
+text editor chosen by the journal writer, rather than via a custom
+web, desktop, or mobile application. The built journal is then served
+with some suitable web server.
+
+The role of jt is to make it easier to create new journal entries (new
+Markdown files), and to make all the common tasks of maintaining a
+knowledge base have minimal friction.
+
+## Example
+
+The following example creates a new journal, which will be the default
+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 new --tag meta --tag journalling "My first journal entry"
+... # text editor is opened so the new entry can be written
+$ jt finish
+~~~
+
+
+
---
title: "jt&mdash;a journalling tool"
author: