Nicer readme

This commit is contained in:
Dag Evensberget 2019-11-28 16:47:06 +10:00
parent d9869005e2
commit d2df797615
2 changed files with 10 additions and 61 deletions

View File

@ -1,65 +1,14 @@
# swmf README # SWMF configuration file syntax highlighting
This is the README for your extension "swmf". After writing up a brief description, we recommend including the following sections. Syntax highlighting and some code completion for [Space Weather Modelling Framework (SWMF)](http://csem.engin.umich.edu/tools/swmf/) configuration files, such as the BATSRUS `PARAM.in` file. The rules are based on the [SWMF manual](http://csem.engin.umich.edu/tools/swmf/documentation/SWMF.pdf) section 3.2.2.
Automatically highlights files ending in `.in` and `.IN`.
![highlight and folding demo](images/highlight-demo.png)
## Features ## Features
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. * Syntax highlighting
* Comment/uncomment using `!` as comment character.
For example if there is an image subfolder under your extension project workspace: * Code folding between `#BEGIN_COMP` and `#END_COMP` markers.
* Autoclosing of `#BEGIN_COMP`.
\!\[feature X\]\(images/feature-x.png\)
> 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
**Note:** 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) or `Cmd+Space` (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!**

BIN
images/highlight-demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB