Skip to content

Commit 7467f26

Browse files
fatoboistsuzmue
authored andcommitted
README: edit Quickstart and Features section for clarity
Clarified steps of Quickstart, added bulleted list to clean up features section and renamed to "Feature highlights" Change-Id: I4356ba3abb5d983516a4a25af2599b2c6b0f3c73 GitHub-Last-Rev: 72335a4 GitHub-Pull-Request: #2394 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/421695 Reviewed-by: Nooras Saba‎ <saba@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
1 parent e4a94d2 commit 7467f26

File tree

1 file changed

+37
-23
lines changed

1 file changed

+37
-23
lines changed

README.md

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,22 @@ Welcome! 👋🏻<br/>
2424
Whether you are new to Go or an experienced Go developer, we hope this
2525
extension fits your needs and enhances your development experience.
2626

27-
* **Step 1.** If you haven't done so already, install [Go](https://golang.org)
28-
and the [VS Code Go extension].
29-
* [Go installation guide]. This extension works best with Go 1.14+.
30-
* [Managing extensions in VS Code].
31-
* **Step 2.** To activate the extension, open any directory or workspace
32-
containing Go code. Once activated, the [Go status bar](https://github.com/golang/vscode-go/wiki/ui) will
33-
appear in the bottom left corner of the window and show the recognized Go
34-
version.
35-
* **Step 3.** The extension depends on [a set of extra command-line tools](#tools).
36-
If they are missing, the extension will show the "⚠️ Analysis Tools Missing"
37-
warning. Click the notification to complete the installation.
27+
1. Install [Go](https://golang.org) 1.14 or newer if you haven't already.
28+
29+
1. Install the [VS Code Go extension].
30+
31+
1. Open any directory or workspace containing Go code to automatically activate
32+
the extension. The
33+
[Go status bar](https://github.com/golang/vscode-go/wiki/ui) appears in the
34+
bottom left corner of the window and displays your Go version.
35+
36+
1. The extension depends on `go`, `gopls`, `dlv` and other optional tools. If
37+
any of the dependencies are missing, the ⚠️ `Analysis Tools Missing` warning
38+
is displayed. Click on the warning to download dependencies.
39+
40+
See the
41+
[tools documentation](https://github.com/golang/vscode-go/wiki/tools) for a
42+
complete list of tools the extension depends on.
3843

3944
<p align="center">
4045
<img src="docs/images/installtools.gif" width=75%>
@@ -44,23 +49,32 @@ extension fits your needs and enhances your development experience.
4449

4550
You are ready to Go :-) &nbsp;&nbsp; 🎉🎉🎉
4651

47-
Please be sure to learn more about the many [features](#features) of this
48-
extension, as well as how to [customize](#customization) them. Take a look at
49-
[Troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting) and [Help](#ask-for-help) for further
50-
guidance.
52+
## What's next
53+
54+
* Explore more [features](#features) of the VS Code Go extension.
55+
* Learn how to [customize](#customization) your settings.
56+
* Solve issues with
57+
[Troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting).
58+
* [file an issue](https://github.com/golang/vscode-go/issues/new/choose) for
59+
problems with the extension.
60+
* Start a [GitHub discussion](https://github.com/golang/vscode-go/discussions)
61+
or get help on [Stack Overflow].
5162

5263
If you are new to Go, [this article](https://golang.org/doc/code.html) provides
5364
the overview on Go code organization and basic `go` commands. Watch ["Getting
5465
started with VS Code Go"] for an explanation of how to build your first Go
5566
application using VS Code Go.
5667

57-
## Features
68+
## Feature highlights
69+
70+
* [IntelliSense] - Results appear for symbols as you type.
71+
* [Code navigation] - Jump to or peek at a symbol's declaration.
72+
* [Code editing] - Support for saved snippets, formatting and code organization,
73+
and automatic organization of imports.
74+
* [Diagnostics] - Build, vet, and lint errors shown as you type or on save.
75+
* Enhanced support for [testing] and [debugging]
5876

59-
This extension provides many features, including [IntelliSense],
60-
[code navigation], and [code editing] support. It also shows [diagnostics] as
61-
you work and provides enhanced support for [testing] and [debugging] your
62-
programs. See the [full feature breakdown] for more details and to learn how to
63-
tune its behavior.
77+
See the [full feature breakdown] for more details.
6478

6579
<p align=center>
6680
<img src="docs/images/completion-signature-help.gif" width=75%>
@@ -182,8 +196,8 @@ conduct-related issue, please mail conduct@golang.org.
182196
[Go installation guide]: https://golang.org/doc/install
183197
["Getting started with VS Code Go"]: https://youtu.be/1MXIGYrMk80
184198
[IntelliSense]: https://github.com/golang/vscode-go/wiki/features#intellisense
185-
[code navigation]: https://github.com/golang/vscode-go/wiki/features#code-navigation
186-
[code editing]: https://github.com/golang/vscode-go/wiki/features#code-editing
199+
[Code navigation]: https://github.com/golang/vscode-go/wiki/features#code-navigation
200+
[Code editing]: https://github.com/golang/vscode-go/wiki/features#code-editing
187201
[diagnostics]: https://github.com/golang/vscode-go/wiki/features#diagnostics
188202
[testing]: https://github.com/golang/vscode-go/wiki/features#run-and-test-in-the-editor
189203
[debugging]: https://github.com/golang/vscode-go/wiki/debugging#features

0 commit comments

Comments
 (0)