summaryrefslogtreecommitdiff
path: root/README.md
blob: f9acd86831fbdc582fdc83bd6f1141f3d4701f6f (plain)
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
# craft

`craft` is a minimal build automation tool for Linux.

## Build

Executing the `build.sh` script inside the root of the craft source code will
create the craft Linux executable. Only the `go` tool and a posix shell is
required.

## Usage

Craft is used as a Git hook. It can be enabled for a given Git repository and
hook by creating a symbolic link:

```
ln -s path/to/craft path/to/repository/.git/hooks/post-receive
```

Currently only the `post-receive` hook is supported. This can be performed also
with a bare repository:

```
ln -s path/to/craft path/to/bare/repository.git/hooks/post-receive
```

Whenever such a repository received updates via `git push` craft will be
executed and prints text to the console of the user who pushed the updates.