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`.
20 lines
1.5 KiB
Markdown
20 lines
1.5 KiB
Markdown
|
|
|
|
[](https://raw.githubusercontent.com/derekparker/delve/master/LICENSE)
|
|
[](https://godoc.org/github.com/derekparker/delve)
|
|
[](https://travis-ci.org/derekparker/delve)
|
|
[](https://ci.appveyor.com/project/derekparker/delve)
|
|
[](https://gitter.im/derekparker/delve?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
**This project is currently pre 1.0.**
|
|
|
|
The Github issue tracker is for **bugs** only. Please use the [developer mailing list](https://groups.google.com/forum/#!forum/delve-dev) for any feature proposals and discussions.
|
|
|
|
### About Delve
|
|
|
|
- [Documentation](Documentation)
|
|
- [Building](Documentation/installation)
|
|
- [Contributing](CONTRIBUTING.md)
|
|
|
|
Delve is a debugger for the Go programming language. The goal of the project is to provide a simple, full featured debugging tool for Go. Delve should be easy to invoke and easy to use. Chances are if you're using a debugger, most likely things aren't going your way. With that in mind, Delve should stay out of your way as much as possible.
|