|
1 | | -# overmind-devtools README |
| 1 | +<h1 align="center"> |
| 2 | + <br> |
| 3 | + <img src="https://github.com/cerebral/overmind/blob/next/logo.png?raw=true" alt="logo" width="100"> |
| 4 | + <br> |
| 5 | + Overmind Devtools for VS Code |
| 6 | + <br> |
| 7 | + <br> |
| 8 | +</h1> |
2 | 9 |
|
3 | | -This is the README for your extension "overmind-devtools". After writing up a brief description, we recommend including the following sections. |
| 10 | +<h4 align="center">Devtools for Overmind - <a href="https://overmindjs.org/">https://overmindjs.org/</a></h4> |
4 | 11 |
|
5 | | -## Features |
6 | | - |
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 12 | +## Getting started |
8 | 13 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 14 | +1. Grab extension from [marketplace](https://marketplace.visualstudio.com/items?itemName=overmind.devtools) |
| 15 | +2. Run the command `Overmind Devtools: Start` |
10 | 16 |
|
11 | | -\!\[feature X\]\(images/feature-x.png\) |
12 | 17 |
|
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. |
| 18 | +## Features |
14 | 19 |
|
15 | | -## Requirements |
| 20 | +- explore state |
| 21 | +- etc etc |
16 | 22 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
18 | 23 |
|
19 | 24 | ## Extension Settings |
20 | 25 |
|
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 | | - |
23 | | -For example: |
24 | | - |
25 | 26 | This extension contributes the following settings: |
26 | 27 |
|
27 | | -* `myExtension.enable`: enable/disable this extension |
28 | | -* `myExtension.thing`: set to `blah` to do something |
| 28 | +* `overmind-devtools.port`: port for devtools backend server |
| 29 | +* `overmind-devtools.verbose`: toggle verbose logging |
29 | 30 |
|
30 | 31 | ## Known Issues |
31 | 32 |
|
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 ... |
| 33 | +* Relaunch does not work. |
| 34 | +* overmind-devtools-client dist files are manually copied into overmind-devtools-vscode |
| 35 | +* storage in overmind-devtools-vscode is a dummy, and must be updated to VSCode APIs |
| 36 | +* DevtoolsPanel needs a refactor and must implement more VS apis |
41 | 37 |
|
42 | | -### 1.0.1 |
43 | 38 |
|
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/) |
| 39 | +## Release Notes |
64 | 40 |
|
65 | | -**Enjoy!** |
| 41 | +TODO |
0 commit comments