Skip to content

Commit b3495a5

Browse files
committed
Update README
1 parent 576d9b1 commit b3495a5

File tree

1 file changed

+41
-7
lines changed

1 file changed

+41
-7
lines changed

README.md

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,57 @@
11
[![Build Status](https://travis-ci.org/fd0/grobi.svg?branch=master)](https://travis-ci.org/fd0/grobi)
22

33
# grobi
4+
45
Watch for changes in outputs for the i3 window manager and react accordingly
56

6-
# Requirements
7+
# Installation
8+
9+
Grobi requires Go version 1.4 or newer. To build grobi, run the following command:
710

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:
911
```shell
10-
$ go get github.com/constabulary/gb/...
12+
$ go run build.go
1113
```
1214

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:
1441

15-
Get all dependencies:
1642
```shell
17-
$ gb vendor restore
43+
$ go get github.com/constabulary/gb/...
1844
```
1945

20-
Compile the program:
46+
The program can be compiled using `gb` as follows:
47+
2148
```shell
2249
$ gb build
2350
```
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

Comments
 (0)