mochapowered/mocha-vscode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Michael Becker 2023-11-26 23:25:36 -05:00
parent 49b5625d75
commit d877fc2bed
1 changed files with 13 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,25 +1,21 @@
# suvmanager README # mocha-vscode
This is the README for your extension "suvmanager". After writing up a brief description, we recommend including the following sections. This is the VSCode/VSCodium extension for directly interfacing with Mocha Advanced Database Infrastructure systems from within the IDE.
## Features ## Features
* Access instances, attributes, and relationships directly from a MADI server as YAML / ZQ definitions
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. * Remotely spin up, shut down, and manage tenants on provisioned Single User Virtual Machines (SUVs)
For example if there is an image subfolder under your extension project workspace:
\!\[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 ## Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them. * This extension makes heavy use of the Mocha command line utility. Please make sure that is installed in /usr/bin/mocha and /usr/lib/mocha.
* To provision and maintain Single User Virtual Machines (SUVs), VirtualBox and Vagrant must be installed on your local machine. Support for remote administration is planned but not implemented at this time.
## Extension Settings ## Extension Settings
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. This extension does not add any VS Code settings through the `contributes.configuration` extension point (yet!)
<!--
For example: For example:
This extension contributes the following settings: This extension contributes the following settings:
@ -27,45 +23,18 @@ This extension contributes the following settings:
* `myExtension.enable`: Enable/disable this extension. * `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something. * `myExtension.thing`: Set to `blah` to do something.
-->
## Known Issues ## Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension. Nothing works yet. This is being addressed and hopefully a fix will be issued soon.
## Release Notes ## Release Notes
Users appreciate release notes as you update your extension. ### 0.0.1
### 1.0.0 Initial release of Mocha-VSCode.
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 your extension.
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
## 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!** **Enjoy!**