|
1 | 1 | [](https://travis-ci.org/fd0/grobi) |
2 | 2 |
|
3 | 3 | # grobi |
| 4 | + |
4 | 5 | Watch for changes in outputs for the i3 window manager and react accordingly |
5 | 6 |
|
6 | | -# Requirements |
| 7 | +# Installation |
| 8 | + |
| 9 | +Grobi requires Go version 1.4 or newer. To build grobi, run the following command: |
7 | 10 |
|
8 | | -Grobi requires Go version 1.4 or newer and the build tool [gb](https://getgb.io). The latter can be installed by running the following command: |
9 | 11 | ```shell |
10 | | -$ go get github.com/constabulary/gb/... |
| 12 | +$ go run build.go |
11 | 13 | ``` |
12 | 14 |
|
13 | | -# Installation |
| 15 | +Afterwards please find a binary of grobi in the current directory: |
| 16 | +``` |
| 17 | +$ ./grobi --help |
| 18 | +Usage: |
| 19 | + grobi [OPTIONS] <command> |
| 20 | +
|
| 21 | +Application Options: |
| 22 | + -v, --verbose Be verbose (false) |
| 23 | + -C, --config= Read config from this file |
| 24 | + -n, --dry-run Only print what commands would be executed without actually runnig them |
| 25 | + -i, --interval= Number of seconds between polls, set to zero to disable polling (5) |
| 26 | + -p, --pause= Number of seconds to pause after a change was executed (2) |
| 27 | +
|
| 28 | +Help Options: |
| 29 | + -h, --help Show this help message |
| 30 | +
|
| 31 | +Available commands: |
| 32 | + apply apply a rule |
| 33 | + update update outputs |
| 34 | + version display version |
| 35 | + watch watch for changes |
| 36 | +``` |
| 37 | + |
| 38 | +# Development |
| 39 | + |
| 40 | +Grobi is developed using the build tool [gb](https://getgb.io). It can be installed by running the following command: |
14 | 41 |
|
15 | | -Get all dependencies: |
16 | 42 | ```shell |
17 | | -$ gb vendor restore |
| 43 | +$ go get github.com/constabulary/gb/... |
18 | 44 | ``` |
19 | 45 |
|
20 | | -Compile the program: |
| 46 | +The program can be compiled using `gb` as follows: |
| 47 | + |
21 | 48 | ```shell |
22 | 49 | $ gb build |
23 | 50 | ``` |
| 51 | + |
| 52 | +# Compatibility |
| 53 | + |
| 54 | +Grobi follows [Semantic Versioning](http://semver.org) to clearly define which |
| 55 | +versions are compatible. The configuration file and command-line parameters and |
| 56 | +user-interface are considered the "Public API" in the sense of Semantic |
| 57 | +Versioning. |
0 commit comments