[fidl][lsp] Update READMEs
Change-Id: I898fb3e30003af8806f621ab916c38d64377bdeb
Reviewed-on: https://fuchsia-review.googlesource.com/c/fidl-misc/+/400855
Reviewed-by: Benjamin Prosnitz <bprosnitz@google.com>
diff --git a/fidl-lsp/README.md b/fidl-lsp/README.md
index 54102e2..0a69519 100644
--- a/fidl-lsp/README.md
+++ b/fidl-lsp/README.md
@@ -5,12 +5,18 @@
## Getting Started
+See the [VSCode extension README][vscode-extension-readme] for more information
+on how to install and setup the FIDL LSP extension in VSCode.
+
+## Contributing
+
To launch a local test instance of VSCode running the extension:
1. Follow the [Fuchsia: Get Started](https://fuchsia.dev/fuchsia-src/getting_started)
guide.
-2. Run `fx gen` to make sure `fidl_project.json` exists.
-3. Build fidl-lint: `fx build host_x64/fidl-lint`.
+2. Run `fx gen` and then `fx build build/fidl:validate_fidl_project_json` to
+ make sure fidl_project.json exists.
+3. Build `fidl-lint`: `fx build host_x64/fidl-lint`.
4. Ensure that you have [Go](https://golang.org/) and [Node.js](https://nodejs.org/)
installed.
5. Fetch prebuilts and compile the language server and VSCode extension by
@@ -18,15 +24,14 @@
6. Open the `fidl-misc/vscode-language-fidl/` directory in VSCode, and run the
`Launch Extension` task.
-If you want to use local versions of fidlc and fidl-format instead of the latest
-SDK versions, you can edit the extension settings in VSCode. (You may need to
-reload the editor for the settings to take effect.)
-
## Testing
To run tests: `go test -p 1 ./...`
+
The `-p` flag specifies that we don't want tests run in parallel, as some of
-them write to and read from the filesystem and can collide.
+them write to and read from the filesystem and can collide. If you want to force
+your tests to be re-run (as test results are cached and not re-run until code in
+that package has changed), you can run with the flag `-count 1`.
## Architecture
@@ -131,3 +136,5 @@
- [ ] [textDocument/rename](https://microsoft.github.io/language-server-protocol/specification#textDocument_rename)
- [ ] [textDocument/prepareRename](https://microsoft.github.io/language-server-protocol/specification#textDocument_prepareRename)
- [ ] [textDocument/foldingRange](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange)
+
+[vscode-extension-readme]: https://fuchsia.googlesource.com/fidl-misc/+/refs/heads/master/vscode-language-fidl/README.md
diff --git a/vscode-language-fidl/README.md b/vscode-language-fidl/README.md
index 4313133..8408d70 100644
--- a/vscode-language-fidl/README.md
+++ b/vscode-language-fidl/README.md
@@ -1,7 +1,20 @@
# FIDL Language Support for Visual Studio Code
This extension provides support for fidl-lsp, an LSP language server for
-[FIDL][fidl]. For more information, see the fidl-lsp [README][fidl-lsp-readme].
+[FIDL][fidl]. For more information about the language server, how to run a test
+instance, and how to contribute, see the fidl-lsp [README][fidl-lsp-readme].
+
+## Getting Started
+
+1. Run `fx gen` and `fx build build/fidl:validate_fidl_project_json`
+2. Download VSCode and install the [FIDL Language extension][extension].
+3. Launch VSCode and open a FIDL file, and you should be ready to go!
+
+If you want to use local versions of fidlc and fidl-format instead of the latest
+SDK versions, you can edit the extension settings in VSCode. (You may need to
+reload the editor for the settings to take effect.)
+
+## Syntax Highlighting
In addition to LSP capabilities, this extension provides syntax highlighting.
The syntax highlighting is generated by a script called `generate-syntax.ts`.
@@ -14,3 +27,4 @@
[fidl]: https://fuchsia.dev/fuchsia-src/development/languages/fidl
[fidl-lsp-readme]: https://fuchsia.googlesource.com/fidl-misc/+/refs/heads/master/fidl-lsp/README.md
+[extension]: https://marketplace.visualstudio.com/items?itemName=fuchsia-authors.language-fidl
