TUTORIAL


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

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 "These are my tickets"
    cd my-tickets

The first argument to `init` is the directory the repository should be
in. This directory mustn't exist yet. The second argument is a
description of the repository: what is repository meant for?

After you've initialised the repository, it contains some metadata
about the repository:

    .git
    repo.yaml

The `.git` subdirectory is used by git for storing versions of all the
other files. This is needed for distributed and offline operation with
the ticketing system, and for merging and synchronising tickets across
computers.

`repo.yaml` contains some metadata about the repository itself. Most
importantly, it contains the description of the repository you gave
`init`.