jim-davis-vscode README

This is the README for Jim's extension "jim-davis-vscode". After writing up a brief description, Jim recommends including the following sections.

Features

Describe specific features of Jim's extension including screenshots of Jim's extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under Jim's extension project workspace:


Tip: Many popular extensions utilize animations. This is an excellent way to show off Jim's extension! We recommend short, focused animations that are easy to follow.

Requirements

If Jim has any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if Jim's 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 Jim from opening duplicate issues against His own extension.

Release Notes

Jim appreciates release notes as you update His 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 Jim's extension.

• Extension Guidelines

Working with Markdown

You can author Jim's 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
• Markdown Syntax Reference

Enjoy!