63a660820e
Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
18 lines
552 B
Markdown
18 lines
552 B
Markdown
# Installation on Linux
|
|
|
|
Please use the following steps to build and install Delve on Linux.
|
|
|
|
There are two ways to install on Linux. First is the standard `go get` method:
|
|
|
|
```
|
|
go get github.com/derekparker/delve/cmd/dlv
|
|
```
|
|
|
|
Alternatively, you can clone the repo and run:
|
|
|
|
```
|
|
$ make install
|
|
```
|
|
|
|
Note: If you are using Go 1.5 you must set `GO15VENDOREXPERIMENT=1` before continuing. The `GO15VENDOREXPERIMENT` env var simply opts into the [Go 1.5 Vendor Experiment](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo/).
|