Skip to content

Commit 24180a3

Browse files
committed
docs: update README.md
1 parent 5dd3ceb commit 24180a3

File tree

2 files changed

+8
-56
lines changed

2 files changed

+8
-56
lines changed

README.md

Lines changed: 8 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,17 @@
1-
# cortex-command-community-project-language-support README
1+
# Cortex Command Community Project Language Support
22

3-
This is the README for your extension "cortex-command-community-project-language-support". After writing up a brief description, we recommend including the following sections.
3+
This extension is designed to support the development of content and mods for the game Cortex Command, specifically the open source community project.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
Adds syntax highlighting, including support for:
88

9-
For example if there is an image subfolder under your extension project workspace:
9+
- Keyword and class name recognition
10+
- Comment , including block comments matching the project's format
11+
- Module reference underlines
1012

11-
\!\[feature X\]\(images/feature-x.png\)
12-
13-
> 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.
14-
15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
13+
\!\[syntax_highlighting\]\(docs/syntax_highlighting.png\)
1814

1915
## Extension Settings
2016

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
- `myExtension.enable`: Enable/disable this extension.
28-
- `myExtension.thing`: Set to `blah` to do something.
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Working with Markdown
53-
54-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
57-
- Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
58-
- Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
59-
60-
## For more information
61-
62-
- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
64-
65-
**Enjoy!**
17+
_NA (Not currently implemented)_
File renamed without changes.

0 commit comments

Comments
 (0)