This is the README for the extension "usfmeditor". Todo is to write a brief description and then to list the following features..
Describe specific features of this extension including screenshots of this extension in action. Image paths are relative to this README file.
For example if there is an image subfolder under this extension project workspace:
![feature X](images/feature-x.png)
Tip: Many popular extensions utilize animations. This is an excellent way to show off this extension! We recommend short, focused animations that are easy to follow.
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Include if this 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 toblah
to do something.
Calling out known issues can help limit users opening duplicate issues against this extension.
Users appreciate release notes as you update this extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
Ensure that you've read through the extensions guidelines and follow the best practices for creating this extension.
You can author this README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\
on macOS orCtrl+\
on Windows and Linux). - Toggle preview (
Shift+Cmd+V
on macOS orShift+Ctrl+V
on Windows and Linux). - Press
Ctrl+Space
(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!