Skip to content

Commit 3c71ee9

Browse files
committed
[release]: merge master@d762a13 to release
d762a13 README.md: use the exact links 1707d4b README: add troubleshooting section, some cleanup Change-Id: I3355f45913b40f324aa04b5c790e7570402b06fa
2 parents b55b129 + d762a13 commit 3c71ee9

File tree

1 file changed

+55
-45
lines changed

1 file changed

+55
-45
lines changed

README.md

Lines changed: 55 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ extension fits your needs and enhances your development experience.
2121
* **Step 1.** If you haven't done so already, install [Go](https://golang.org)
2222
and the [VS Code Go extension].
2323
* [Go installation guide]. This extension works best with Go 1.14+.
24-
* [Manage extensions in VS Code].
24+
* [Managing extensions in VS Code].
2525
* **Step 2.** To activate the extension, open any directory or workspace
2626
containing Go code. Once activated, the [Go status bar](docs/ui.md) will
2727
appear in the bottom left corner of the window and show the recognized Go
@@ -38,23 +38,23 @@ extension fits your needs and enhances your development experience.
3838

3939
You are ready to Go :-)    🎉🎉🎉
4040

41-
Please be sure to learn more about many [features](#features) of this extension
42-
as well as how to [customize](#customization) them. Take a look at
41+
Please be sure to learn more about the many [features](#features) of this
42+
extension, as well as how to [customize](#customization) them. Take a look at
4343
[Troubleshooting](docs/troubleshooting.md) and [Help](#ask-for-help) for further
4444
guidance.
4545

4646
If you are new to Go, [this article](https://golang.org/doc/code.html) provides
47-
the overview on go code organization and basic `go` commands. The recent
48-
[Go open source live video] featured VS Code Go and demonstrated how other
49-
Gophers use the features to enhance their Go development workflow.
47+
the overview on Go code organization and basic `go` commands. Watch [this video
48+
from the Go Open Source Live conference] for an explanation of how to build
49+
your first Go application using VS Code Go.
5050

5151
## Features
5252

5353
This extension provides many features, including [IntelliSense],
54-
[code navigation], [code editing] support. It also shows [diagnostics] as you
55-
work and provides enhanced support for [testing] and [debugging] your programs.
56-
See the [full feature breakdown] for more details and to learn how to tune the
57-
behavior.
54+
[code navigation], and [code editing] support. It also shows [diagnostics] as
55+
you work and provides enhanced support for [testing] and [debugging] your
56+
programs. See the [full feature breakdown] for more details and to learn how to
57+
tune its behavior.
5858

5959
<p align=center>
6060
<img src="docs/images/completion-signature-help.gif" width=75%>
@@ -66,68 +66,75 @@ In addition to integrated editing features, the extension provides several
6666
commands for working with Go files. You can access any of these by opening the
6767
Command Palette (`Ctrl+Shift+P` on Linux/Windows and `Cmd+Shift+P` on Mac), and
6868
then typing in the command name. See the
69-
[full list of commands](docs/commands.md#detailed-list) provided by the
69+
[full list of commands](docs/commands.md#detailed-list) provided by this
7070
extension.
7171

7272
<p align=center>
7373
<img src="docs/images/toggletestfile.gif" width=75%>
7474
<br/><em>(Toggle Test File)</em></p>
7575

76-
**⚠️ Note**: the default syntax highlighting for Go files is provided by the
76+
**⚠️ Note**: the default syntax highlighting for Go files is provided by a
7777
[TextMate rule](https://github.com/jeff-hykin/better-go-syntax) embedded in VS
7878
Code, not by this extension.
7979

8080
## Tools
8181

8282
The extension uses a few command-line tools developed by the Go community. In
83-
particular, `go`, `gopls`, and `dlv` are used to implement build/test, language
84-
features, and debugging functionalities of this extension. See the
85-
[tools documentation](docs/tools.md) for a complete list of tools the extension
86-
depends on.
87-
88-
In order to locate the command-line tools, the extension searches `$GOPATH/bin`
89-
and directories specified in the `PATH` environment variable (or `Path` in
90-
Windows) with which the VS Code process has started. If the tools are not found,
91-
the extension will prompt you to install the missing tools and show the "⚠️
92-
Analysis Tools Missing" warning in the bottom right corner. Please install them
93-
by responding to the warning notification, or by manually running the `Go:
94-
Install/Update Go Tools` command. The extension will run the
95-
[`go get`](https://golang.org/cmd/go) command to install them.
83+
particular, `go`, `gopls`, and `dlv` **must** be installed for this extension
84+
to work correctly. See the [tools documentation](docs/tools.md) for a complete
85+
list of tools the extension depends on.
86+
87+
In order to locate these command-line tools, the extension searches
88+
`GOPATH/bin` and directories specified in the `PATH` environment variable (or
89+
`Path` on Windows) with which the VS Code process has started. If the tools are
90+
not found, the extension will prompt you to install the missing tools and show
91+
the "⚠️ Analysis Tools Missing" warning in the bottom right corner. Please
92+
install them by responding to the warning notification, or by manually running
93+
the [`Go: Install/Update Go Tools` command].
9694

9795
## Setting up your workspace
9896

9997
[Go modules](https://golang.org/ref/mod) are how Go manages dependencies in
10098
recent versions of Go. Modules replace the `GOPATH`-based approach to specifying
10199
which source files are used in a given build, and they are the default build
102100
mode in go1.16+. While this extension continues to support both Go modules and
103-
`GOPATH` mode, we highly recommend Go development in module mode. If you are
101+
`GOPATH` modes, we highly recommend Go development in module mode. If you are
104102
working on existing projects, please consider migrating to modules.
105103

106104
Unlike the traditional `GOPATH` mode, module mode does not require the workspace
107105
to be located under `GOPATH` nor to use a specific structure. A module is
108106
defined by a directory tree of Go source files with a `go.mod` file in the
109-
tree's root directory. Your project may involve one or more modules. If you are
110-
working with multiple modules or uncommon project layouts, you will need to
111-
configure your workspace so that the extension knows which code to load, so that
112-
features like references can work across modules. Please see the
113-
for information on supported workspace layouts.
107+
tree's root directory.
108+
109+
Your project may involve one or more modules. If you are working with multiple
110+
modules or uncommon project layouts, you will need to configure your workspace
111+
by using [Workspace Folders]. Please see this [documentation about supported
112+
workspace layouts].
114113

115114
## Customization
116115

117116
The extension needs no configuration and should work out of the box. However,
118-
you may wish to adjust settings to customize its behavior. Below are a few
119-
commonly used settings. Please see the
117+
you may wish to adjust settings to customize its behavior. Please see the
120118
[settings documentation](docs/settings.md) for a comprehensive list of settings.
121119
See [advanced topics](docs/advanced.md) for further customizations and unique
122120
use cases.
123121

122+
## Troubleshooting
123+
124+
If the extension isn't working as you expect, you can take a look at our
125+
troubleshooting guides. There is one for [general
126+
troubleshooting](docs/troubleshooting.md), and another specifically for
127+
[troubleshooting the debugging feature](docs/debugging.md#troubleshooting).
128+
124129
## Ask for help
125130

126-
If you're having issues with this extension, please reach out to us by
127-
[filing an issue](https://github.com/golang/vscode-go/issues/new/choose) or
128-
asking a question on the [Gophers Slack]. We hang out in the `#vscode` channel!
131+
If the troubleshooting guides did not resolve the issue, please reach out to us
132+
by [filing an issue](https://github.com/golang/vscode-go/issues/new/choose),
133+
[starting a GitHub discussion](https://github.com/golang/vscode-go/discussions),
134+
or by asking a question in the [Gophers Slack]. We hang out in the `#vscode`
135+
channel!
129136

130-
Take a look at [learn.go.dev](https://learn.go.dev) and
137+
Also, you can take a look at [learn.go.dev](https://learn.go.dev) and
131138
[golang.org/help](https://golang.org/help) for more general guidance on using
132139
Go.
133140

@@ -158,15 +165,18 @@ conduct-related issue, please mail [email protected].
158165
[Gophers Slack]: https://gophers.slack.com/
159166
[`gopls`]: https://golang.org/s/gopls
160167
[`go`]: https://golang.org/cmd/go
161-
[Manage extensions in VS Code]: https://code.visualstudio.com/docs/editor/extension-gallery
168+
[Managing extensions in VS Code]: https://code.visualstudio.com/docs/editor/extension-gallery
162169
[VS Code Go extension]: https://marketplace.visualstudio.com/items?itemName=golang.go
163170
[Go installation guide]: https://golang.org/doc/install
164-
[Go open source live video]: https://opensourcelive.withgoogle.com/events/go/watch?talk=session3
165-
[IntelliSense]: docs/features.md#intellisense
166-
[code navigation]: docs/features.md#code-navigation
167-
[code editing]: docs/features.md#code-editing
168-
[diagnostics]: docs/features.md#diagnostics
169-
[testing]: docs/features.md##run-and-test-in-the-editor
171+
[this video from the Go Open Source Live conference]: https://opensourcelive.withgoogle.com/events/go/watch?talk=session3
172+
[IntelliSense]: https://github.com/golang/vscode-go/blob/master/docs/features.md#intellisense
173+
[code navigation]: https://github.com/golang/vscode-go/blob/master/docs/features.md#code-navigation
174+
[code editing]: https://github.com/golang/vscode-go/blob/master/docs/features.md#code-editing
175+
[diagnostics]: https://github.com/golang/vscode-go/blob/master/docs/features.md#diagnostics
176+
[testing]: https://github.com/golang/vscode-go/blob/master/docs/features.md##run-and-test-in-the-editor
170177
[debugging]: #debugging
171-
[full feature breakdown]: docs/features.md
178+
[full feature breakdown]: https://github.com/golang/vscode-go/blob/master/docs/features.md
172179
[workspace documentation]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
180+
[`Go: Install/Update Go Tools` command]: https://github.com/golang/vscode-go/blob/master/docs/commands.md#go-installupdate-tools
181+
[documentation about supported workspace layouts]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
182+
[Workspace Folders]: https://code.visualstudio.com/docs/editor/multi-root-workspaces

0 commit comments

Comments
 (0)