From 48148e9e97a5cb9b2b425e48dfeb0b4793a9f8f5 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Fri, 18 Apr 2014 14:36:37 +0100 Subject: Tweak tutorial Back out from being able to initialise an empty directory. It's not that useful, and makes command line syntax for setting the repo description harder. --- TUTORIAL | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) (limited to 'TUTORIAL') diff --git a/TUTORIAL b/TUTORIAL index 75f93e1..2d5f0da 100644 --- a/TUTORIAL +++ b/TUTORIAL @@ -11,15 +11,24 @@ 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 + distix init my-tickets "These are 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: +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? - mkdir my-tickets - cd my-tickets - distix init +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. -Use whichever is more convenient for you, they work identically. +`repo.yaml` contains some metadata about the repository itself. Most +importantly, it contains the description of the repository you gave +`init`. -- cgit v1.2.1