bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
burkeholland
2024-10-08 12:44:47 -05:00
parent 9390650280
commit 3fdc2c1d8c
1 changed files with 12 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
lm-api-tutorial/README.md
View File

@ -1,71 +1,16 @@
# code-tutor README
# Language Model API Tutorial Sample
This is the README for your extension "code-tutor". After writing up a brief description, we recommend including the following sections.
This is the source code for the [Language Model API Tutorial](). It demonstrates how to use the GitHub Copilot Language Model API to build an extension that annotates your code with inline tutoring tips.
## Features
## Demo
![Link to demo from docs]()
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
### Running the sample
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.
---
## Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
## Working with Markdown
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, 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!**
- Run `npm install` in terminal to install depedencies
- Run the `Run Extension` target in the Debug View. This will:
- Start a task `npm: watch` to compile the client code
- Run the extension in a new VS Code window.
- Open a folder in the new VS Code window.
- Open a code file.
- Run the `Toggle Tutor Annotations` command from the command palette.