diff options
| author | Adin Scannell <ascannell@google.com> | 2019-06-13 16:49:09 -0700 |
|---|---|---|
| committer | Shentubot <shentubot@google.com> | 2019-06-13 16:50:15 -0700 |
| commit | add40fd6ad4c136bc17d1f243ec199c7bf37fa0b (patch) | |
| tree | 9f0ff70ce69c55ded5b2afae7e66e361e93f3e4e /README.md | |
| parent | 0c8603084d9399fde250c68fe30a084749d937ff (diff) | |
Update canonical repository.
This can be merged after:
https://github.com/google/gvisor-website/pull/77
or
https://github.com/google/gvisor-website/pull/78
PiperOrigin-RevId: 253132620
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 18 insertions, 9 deletions
@@ -53,15 +53,6 @@ Make sure the following dependencies are installed: * [Docker version 17.09.0 or greater][docker] * Gold linker (e.g. `binutils-gold` package on Ubuntu) -### Getting the source - -Clone the repository: - -``` -git clone https://gvisor.googlesource.com/gvisor gvisor -cd gvisor -``` - ### Building Build and install the `runsc` binary: @@ -116,6 +107,24 @@ Then invoke bazel with the following flags: You can also add those flags to your local ~/.bazelrc to avoid needing to specify them each time on the command line. +### Using `go get` + +This project uses [bazel][bazel] to build and manage dependencies. A synthetic +`go` branch is maintained that is compatible with standard `go` tooling for +convenience. + +For example, to build `runsc` directly from this branch: + +``` +echo "module runsc" > go.mod +GO111MODULE=on go get gvisor.dev/gvisor/runsc@go +CGO_ENABLED=0 GO111MODULE=on go install gvisor.dev/gvisor/runsc +``` + +Note that this branch is supported in a best effort capacity, and direct +development on this branch is not supported. Development should occur on the +`master` branch, which is then reflected into the `go` branch. + ## Community & Governance The governance model is documented in our [community][community] repository. |