delve/Documentation/README.md

# Delve Documentation

Documentation for the project will reside in this directory.

- [Installation](installation)
- [Usage](usage)
- [Command Line Interface](cli)
- [API](api)
- [Internal](internal)
- [Editor Integration and Alternative UI](EditorIntegration.md)
- [Known Bugs](KnownBugs.md)
docs: Move wiki docs into Documentation dir 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`. 2016-02-19 18:32:24 +00:00			`# Delve Documentation`

			`Documentation for the project will reside in this directory.`

			`- [Installation](installation)`
			`- [Usage](usage)`
docs: Documentation for command line frontend (#518) * documentation: copied old documentation from wiki * command: better online documentation Help without arguments prints just a short summary for each command, help followed by a command prints the command's syntax and a longer explanation. * documentation: automatically generate Documentation/cli/README.md 2016-04-29 18:58:19 +00:00			`- [Command Line Interface](cli)`
docs: Move wiki docs into Documentation dir 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`. 2016-02-19 18:32:24 +00:00			`- [API](api)`
			`- [Internal](internal)`
documentation: add gdlv to list of alternative UIs (#774) 2017-03-24 23:10:01 +00:00			`- [Editor Integration and Alternative UI](EditorIntegration.md)`
documentation: Add known bugs. 2016-05-18 07:13:21 +00:00			`- [Known Bugs](KnownBugs.md)`