Skip to content

Commit

Permalink
Update readme in syntax highlighting to include info on building and …
Browse files Browse the repository at this point in the history
…installing from vsix
  • Loading branch information
Sean Sullivan committed Jun 17, 2024
1 parent b58d582 commit 60d84a9
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 70 deletions.
65 changes: 6 additions & 59 deletions xm-language/README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,12 @@
# mcr README

This is the README for your extension "mcr". After writing up a brief description, we recommend including the following sections.
## Build

## Features
```
npx vsce package
```

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

For example if there is an image subfolder under your extension project workspace:
## Install

\!\[feature X\]\(images/feature-x.png\)
https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix

> 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

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!**
35 changes: 24 additions & 11 deletions xm-language/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,29 @@
"Programming Languages"
],
"contributes": {
"languages": [{
"id": "xm-macro",
"aliases": ["xmidas", "xm-macro"],
"extensions": [".mcr",".mm"],
"configuration": "./language-configuration.json"
}],
"grammars": [{
"language": "xm-macro",
"scopeName": "source.xmidas",
"path": "./syntaxes/xm-macro.tmLanguage.json"
}]
"languages": [
{
"id": "xm-macro",
"aliases": [
"xmidas",
"xm-macro"
],
"extensions": [
".mcr",
".mm"
],
"configuration": "./language-configuration.json"
}
],
"grammars": [
{
"language": "xm-macro",
"scopeName": "source.xmidas",
"path": "./syntaxes/xm-macro.tmLanguage.json"
}
]
},
"devDependencies": {
"@vscode/vsce": "^2.27.0"
}
}

0 comments on commit 60d84a9

Please sign in to comment.