RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Some more README.md updates.

This commit is contained in:
juliusv 2014-12-06 23:52:19 +01:00
parent c1b0237d4b
commit a0457829ee
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -31,11 +31,8 @@ it will be the recommended way of installing Prometheus.
In most cirumstances, the following should work: In most cirumstances, the following should work:
$ make $ make build
$ ARGUMENTS="-config.file=documentation/examples/prometheus.conf" make run $ ./prometheus -config.file=documentation/examples/prometheus.conf
``${ARGUMENTS}`` is passed verbatim to the commandline starting the Prometheus binary.
This is useful for quick one-off invocations and smoke testing.
The above requires a number of common tools to be installed, namely The above requires a number of common tools to be installed, namely
`curl`, `git`, `gzip`, `hg` (Mercurial CLI), `sed`, `xxd`. Should you `curl`, `git`, `gzip`, `hg` (Mercurial CLI), `sed`, `xxd`. Should you
@ -51,8 +48,8 @@ development environment of the appropriate version.
The `Makefile` offers a number of useful targets. Some examples: The `Makefile` offers a number of useful targets. Some examples:
* `make test` runs tests. * `make test` runs tests.
* `make tarball` creates a tar ball with the binary for distribution. * `make tarball` creates a tarball with the binary for distribution.
* `make race_condition_run` compiles and runs a binary with the race detector enabled. * `make race_condition_run` compiles and runs a binary with the race detector enabled. To pass arguments when running Prometheus this way, set the `ARGUMENTS` environment variable (e.g. `ARGUMENTS=-config.file=./prometheus.conf make race_condition_run`).
### Use your own Go development environment ### Use your own Go development environment
@ -73,7 +70,7 @@ do that.
* The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus). * The source code is periodically indexed: [Prometheus Core](http://godoc.org/github.com/prometheus/prometheus).
* You will find a Travis CI configuration in `.travis.yml`. * You will find a Travis CI configuration in `.travis.yml`.
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers). * All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers) and the `#prometheus` channel on `irc.freenode.net`.
## Contributing ## Contributing