Skip to content

Commit 0adb6b9

Browse files
authored
Update README.md
1 parent 4aedb02 commit 0adb6b9

File tree

1 file changed

+9
-55
lines changed

1 file changed

+9
-55
lines changed

README.md

+9-55
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,19 @@
1-
# func-vscode README
1+
# func-vscode
22

3-
This is the README for your extension "func-vscode". After writing up a brief description, we recommend including the following sections.
3+
[Draft] This extension enables support for FunC in VS Code.
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+
- Syntax highlight
8+
- stdlib code snippets
89

9-
For example if there is an image subfolder under your extension project workspace:
10+
## Building & running
1011

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.
18-
19-
## Extension Settings
20-
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.
12+
1. install deps using `yarn install`
13+
2. run `yarn watch` in terminal
14+
3. use debug menu in VS Code to test extension
3315

3416
## Release Notes
3517

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-
**Note:** 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) or `Cmd+Space` (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/)
18+
No releases now. Stay tuned.
6419

65-
**Enjoy!**

0 commit comments

Comments
 (0)