-
-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add installation guide to VS Code Extension readme #659
base: master
Are you sure you want to change the base?
Add installation guide to VS Code Extension readme #659
Conversation
vscode-extension/README.md
Outdated
@@ -9,9 +9,16 @@ The Numbat extension provides language support for the [Numbat](https://github.c | |||
- comment toggling | |||
- autosurrounding brackets | |||
|
|||
## Installation | |||
|
|||
To install this extension you will need to download the extension installation file (VSIX file), which can be found in the assets of each [numbat release](https://github.com/sharkdp/numbat/releases) after v1.14.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which can be found in the assets
can it? Am I missing something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought that was the approach we agreed on for the distribution of the add-in. I might have misunderstood but that at least was my understanding when writing this paragraph.
This is where I understood it as an agreement on the approach described: #656 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, sorry — yes. But we haven't implemented that (in .github/workflows/ci.yml
) yet 😄 To be honest, I don't even know what VSIX is and/or how to generate it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aah fair. VSIX is just a visual studio code installation executable. So just a packaging format for code extensions to share them. It can be generated via npm with this script: https://github.com/sharkdp/numbat/blob/master/vscode-extension/package.json#L38
I didn't think about changing the GitHub Action but I could probably add it as a step without a problem.
There may be some pluming needed for the files to be added when creating a new release but the setup for generating the VSIX file is now in place |
No description provided.