Skip to content

INSTALL.md

Latest commit

 

History

History
59 lines (38 loc) · 1.56 KB

INSTALL.md

File metadata and controls

59 lines (38 loc) · 1.56 KB
Raw

Manual installation

This is a Visual Studio Code extension. It is best installed from the on-line extensions marketplace, or from inside VS Code Preferences/Extensions and search for swmf-grammar.

Alternatively, the extension can be built and installed manually as in the next section. This should only be required for developers.

Build the extension

  1. Clone the repository and enter into the folder

    git clone git@github.com:svaberg/SWMF-grammar.git
cd SWMF-grammar

  2. Install the required packages with npm

    npm install

  3. Compile with npm

    npm run compile

At this point the extension may be debugged in the Extension Development Host:

code .

followed by the Run/Start Debugging dropdown (or the F5 key). To observe the extension in action, view the file demo.in.

To complete the manual installation, follow the remaining steps to manually create and install the package:

Package and install the extension

  1. Create a package using vsce

    vsce package

    This should generate a swmf-grammar-?.?.?.vsix file in the current directory.

  2. Manually install the extension in VS Code (you may want to replace the wildcards in the version number)

    code --install-extension swmf-grammar-?.?.?.vsix

To test the installation, open the current folder in VS Code

code .

and view the file demo.in.