From 2fb9bb022145755e761d74d179dd1eba856b023f Mon Sep 17 00:00:00 2001 From: Peter Bourgon Date: Mon, 10 Feb 2014 15:03:20 +0100 Subject: [PATCH] Small fixes to READMEs --- README.md | 12 ++---------- roshi-server/README.md | 11 ++++++++--- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2994c79..b9449e4 100644 --- a/README.md +++ b/README.md @@ -297,15 +297,7 @@ Go installed on your computer to build Roshi. If you're on a Mac and use # I just want to run the HTTP service! -roshi-server uses vendored dependencies and a "blessed build" process to ensure -stability. The recommended way to get and build roshi-server is +See the appropriate sections of the [roshi-server README](build-run). - git clone git@github.com:soundcloud/roshi - cd roshi/roshi-server - make - -Invoking `go get` directly (`go get github.com/soundcloud/roshi/roshi-server`) -should work, with the caveat that it will download missing dependencies -directly from their respective master branches, which may not be properly -tested. +[build-run]: https://github.com/soundcloud/roshi/blob/master/roshi-server#getting-and-building diff --git a/roshi-server/README.md b/roshi-server/README.md index 5d85ee3..e54d42e 100644 --- a/roshi-server/README.md +++ b/roshi-server/README.md @@ -16,9 +16,14 @@ stability over time. Users should get and build roshi-server by cloning this repository and running `make` in the roshi-server subdirectory. A working Go toolchain is assumed. -It's also possible to build roshi-server with a simple `go build`, with the -caveat that it will use your normal GOPATH to resolve dependencies, and -therefore will enforce no constraints on dependency versions. + git clone git@github.com:soundcloud/roshi + cd roshi/roshi-server + make + +It's also possible to get roshi-server via `go get`, and/or build it with a +simple `go build`, with the caveat that it will use your normal GOPATH to +resolve dependencies, and therefore will enforce no constraints on dependency +versions, which could introduce bugs or strange behavior. ## Running