bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-06-13 07:10:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update read me

Browse Source
This commit is contained in:
Sandeep Somavarapu
2018-03-21 15:54:35 +05:30
parent dc6cf8048b
commit fdc730dcaa
1 changed files with 9 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
multi-diagnostics-sample/README.md
View File

@ -1,65 +1,13 @@
# multi-diagnostics-sample README
# README
This is the README for your extension "multi-diagnostics-sample". After writing up a brief description, we recommend including the following sections.
This sample generates diagnostics with related information which can be seen in Problems view and in the editor.
## Features
## Set up & Test
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
- Clone this extension
- `npm install`
- Launch the extension
- Open the file `sample-demo.rs` that exists in this extension
- `Problems view` shows an error with related information
- Typing `F8` in the editor also shows the error with related information
For example if there is an image subfolder under your extension project workspace:
\!\[feature X\]\(images/feature-x.png\)
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
## Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
## Extension Settings
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
For example:
This extension contributes the following settings:
* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
## Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
## Release Notes
Users appreciate release notes as you update your extension.
### 1.0.0
Initial release of ...
### 1.0.1
Fixed issue #.
### 1.1.0
Added features X, Y, and Z.
-----------------------------------------------------------------------------------------------------------
## Working with Markdown
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
### For more information
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
**Enjoy!**