summaryrefslogtreecommitdiff
path: root/TUTORIAL
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2014-04-18 14:32:05 +0100
committerLars Wirzenius <liw@liw.fi>2014-04-18 14:32:05 +0100
commite6acc4aca1db7bd8e0ec0395fecbff439239bc35 (patch)
treecffe01983bd73e0e213e9f3e96ee881bf0da5f0a /TUTORIAL
parent721b23c98b57d515c1fa626c218d8927006bdbd1 (diff)
downloaddistix-e6acc4aca1db7bd8e0ec0395fecbff439239bc35.tar.gz
Add the beginnings of a tutorial
Diffstat (limited to 'TUTORIAL')
-rw-r--r--TUTORIAL25
1 files changed, 25 insertions, 0 deletions
diff --git a/TUTORIAL b/TUTORIAL
new file mode 100644
index 0000000..75f93e1
--- /dev/null
+++ b/TUTORIAL
@@ -0,0 +1,25 @@
+distix tutorial
+===============
+
+distix is a distributed ticketing system. This is a tutorial for the
+command line interface.
+
+Initialise a new ticket repository: `distix init`
+-------------------------------------------------
+
+distix keeps all tickets in text files in a git repository. The
+repository is created (or at least initialised) with the `distix init`
+command:
+
+ distix init my-tickets
+ cd my-tickets
+
+The `init` command takes a directory name as its argument.
+Alternatively, you can create an empty directory, change there, and
+run `init` without an argument:
+
+ mkdir my-tickets
+ cd my-tickets
+ distix init
+
+Use whichever is more convenient for you, they work identically.