github.com/golang/dep@v0.5.4/README.md (about)

     1  <p align="center"><img src="docs/assets/DigbyShadows.png" width="360"></p>
     2  <p align="center">
     3    <a href="https://travis-ci.org/golang/dep"><img src="https://travis-ci.org/golang/dep.svg?branch=master" alt="Build Status"></img></a>
     4    <a href="https://ci.appveyor.com/project/golang/dep"><img src="https://ci.appveyor.com/api/projects/status/github/golang/dep?svg=true&branch=master&passingText=Windows%20-%20OK&failingText=Windows%20-%20failed&pendingText=Windows%20-%20pending" alt="Windows Build Status"></a>
     5    <a href="https://goreportcard.com/report/github.com/golang/dep"><img src="https://goreportcard.com/badge/github.com/golang/dep" /></a>
     6  </p>
     7  
     8  <i>Would you like to see your company name here? <a
     9  href="https://github.com/golang/dep/issues/2165">We're looking for a stable source of
    10  funding.</a></i>
    11  
    12  ## Dep
    13  
    14  `dep` is a dependency management tool for Go. It requires Go 1.9 or newer to compile.
    15  
    16  `dep` was the "official experiment." The Go toolchain, as of 1.11, has adopted
    17  an approach that sharply diverges from `dep`. As a result, we are continuing
    18  development of `dep`, but gearing work primarily towards the development of an
    19  alternative prototype for versioning behavior in the toolchain.
    20  
    21  For guides and reference materials about `dep`, see [the
    22  documentation](https://golang.github.io/dep).
    23  
    24  ## Installation
    25  
    26  You should use an officially released version. Release binaries are available on
    27  the [releases](https://github.com/golang/dep/releases) page.
    28  
    29  On MacOS you can install or upgrade to the latest released version with Homebrew:
    30  
    31  ```sh
    32  $ brew install dep
    33  $ brew upgrade dep
    34  ```
    35  
    36  On Debian platforms you can install or upgrade to the latest version with apt-get:
    37  
    38  ```sh
    39  $ sudo apt-get install go-dep
    40  ```
    41  
    42  On Windows, you can download a tarball from
    43  [go.equinox.io](https://go.equinox.io/github.com/golang/dep/cmd/dep).
    44  
    45  On other platforms you can use the `install.sh` script:
    46  
    47  ```sh
    48  $ curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
    49  ```
    50  
    51  It will install into your `$GOPATH/bin` directory by default or any other directory you specify using the `INSTALL_DIRECTORY` environment variable.
    52  
    53  If your platform is not supported, you'll need to build it manually or let the team know and we'll consider adding your platform
    54  to the release builds.
    55  
    56  If you're interested in getting the source code, or hacking on `dep`, you can
    57  install via `go get`:
    58  
    59  ```sh
    60  go get -u github.com/golang/dep/cmd/dep
    61  ```
    62  
    63  ## Feedback
    64  
    65  Feedback is greatly appreciated.
    66  At this stage, the maintainers are most interested in feedback centered on the user experience (UX) of the tool.
    67  Do you have workflows that the tool supports well, or doesn't support at all?
    68  Do any of the commands have surprising effects, output, or results?
    69  Let us know by filing an issue, describing what you did or wanted to do, what you expected to happen, and what actually happened.
    70  
    71  ## Contributing
    72  
    73  Contributions are greatly appreciated.
    74  The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
    75  The project follows the typical GitHub pull request model.
    76  See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
    77  Before starting any work, please either comment on an existing issue, or file a new one.