mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-11-09 23:24:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #823 from prometheus/fabxc/rdme

Browse source 
general README update
This commit is contained in:
Fabian Reinartz 2015-06-23 08:37:49 +02:00
parent 618a9d15f2 024139be00
commit 07347aa1d9
2 changed files with 5 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile.INCLUDE
View file

@ -76,7 +76,6 @@ BUILDFLAGS := -ldflags \
-X $(REPO_PATH)/version.BuildUser $(USER)@$(HOSTNAME)\ -X $(REPO_PATH)/version.BuildUser $(USER)@$(HOSTNAME)\
-X $(REPO_PATH)/version.BuildDate $(BUILD_DATE)\ -X $(REPO_PATH)/version.BuildDate $(BUILD_DATE)\
-X $(REPO_PATH)/version.GoVersion $(GO_VERSION)" -X $(REPO_PATH)/version.GoVersion $(GO_VERSION)"
PROTOC := protoc
CURL := curl CURL := curl
ARCHIVE := prometheus-$(VERSION).$(GOOS)-$(GOARCH).tar.gz ARCHIVE := prometheus-$(VERSION).$(GOOS)-$(GOARCH).tar.gz

17
README.md
View file

@ -48,11 +48,7 @@ In most circumstances, the following should work:
$ ./prometheus -config.file=documentation/examples/prometheus.yml $ ./prometheus -config.file=documentation/examples/prometheus.yml
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).
need to change any of the protocol buffer definition files
(`*.proto`), you also need the protocol buffer compiler
[`protoc`](http://code.google.com/p/protobuf/), v2.5.0 or higher,
in your `$PATH`.
Everything else will be downloaded and installed into a staging Everything else will be downloaded and installed into a staging
environment in the `.build` sub-directory. That includes a Go environment in the `.build` sub-directory. That includes a Go
@ -67,14 +63,11 @@ The `Makefile` offers a number of useful targets. Some examples:
### Use your own Go development environment ### Use your own Go development environment
Using your own Go development environment with the usual tooling is Using your own Go development environment with the usual tooling is
possible, too, but you have to take care of various generated files possible, too. After making changes to the files in `web/static` you
(usually by running `make` in the respective sub-directory): have to run `make` in the `web/` directory. This generates the respective
`web/blob/files.go` file which embedds the static assets in the compiled binary.
* Compiling the protocol buffer definitions in `config` (only if you have changed them). Furthermore, the version information (see `version/info.go`) will not be
* Generating the parser and lexer code in `rules` (only if you have changed `parser.y` or `lexer.l`).
* The `files.go` blob in `web/blob`, which embeds the static web content into the binary.
Furthermore, the build info (see `build_info.go`) will not be
populated if you simply run `go build`. You have to pass in command populated if you simply run `go build`. You have to pass in command
line flags as defined in `Makefile.INCLUDE` (see `${BUILDFLAGS}`) to line flags as defined in `Makefile.INCLUDE` (see `${BUILDFLAGS}`) to
do that. do that.