diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -1,3 +1,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. |