Move manual installation instructions to INSTALL.md
This commit is contained in:
parent
1dc5a4d330
commit
e142693169
|
@ -17,3 +17,5 @@ Tidy README and clean up `devDependencies`.
|
||||||
Mention support for [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs).
|
Mention support for [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs).
|
||||||
### 0.2.5
|
### 0.2.5
|
||||||
Add icon to marketplace.
|
Add icon to marketplace.
|
||||||
|
### 0.2.6
|
||||||
|
Move manual installation instructions to [INSTALL.md](INSTALL.md). Add transparent icon borders.
|
||||||
|
|
43
INSTALL.md
Normal file
43
INSTALL.md
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
>This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), 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.
|
||||||
|
|
||||||
|
## Manual installation from source code
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
1. Clone the repository and enter into the folder
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone git@github.com:svaberg/SWMF-grammar.git
|
||||||
|
cd SWMF-grammar
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install the required packages with `npm`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Create a package using `vsce`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
vsce package
|
||||||
|
```
|
||||||
|
|
||||||
|
This should generate a `swmf-grammar-?.?.?.vsix` file in the current directory.
|
||||||
|
4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
code --install-extension swmf-grammar-?.?.?.vsix
|
||||||
|
```
|
||||||
|
|
||||||
|
To test the installation, open the current folder in VS Code
|
||||||
|
|
||||||
|
```bash
|
||||||
|
code .
|
||||||
|
```
|
||||||
|
|
||||||
|
and view the file `demo.in`.
|
42
README.md
42
README.md
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
This extension provides syntax highlighting, outline view, breadcrumbs, 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.
|
This extension provides syntax highlighting, outline view, breadcrumbs, 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`.
|
Automatically highlights files ending in `.in` and `.IN`. For files lacking these extensions, the language can be set manually via normal VS Code mechanisms.
|
||||||
|
|
||||||
![Features demo](images/demo.png)
|
![Features demo](images/demo.png)
|
||||||
|
|
||||||
|
@ -21,42 +21,6 @@ Automatically highlights files ending in `.in` and `.IN`.
|
||||||
|
|
||||||
This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), or from inside VS Code `Preferences/Extensions` and search for `swmf-grammar`.
|
This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), 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.
|
To test the installation, just open a handy SWMF `PARAM.in` file.
|
||||||
|
|
||||||
### Manual installation from source code
|
Alternatively, the extension can be [built, installed and tested manually](INSTALL.md).
|
||||||
|
|
||||||
> This should only be required for developers.
|
|
||||||
|
|
||||||
1. Clone the repository and enter into the folder
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone git@github.com:svaberg/SWMF-grammar.git
|
|
||||||
cd SWMF-grammar
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Install the required packages with `npm`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Create a package using `vsce`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
vsce package
|
|
||||||
```
|
|
||||||
|
|
||||||
This should generate a `swmf-grammar-?.?.?.vsix` file in the current directory.
|
|
||||||
4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
code --install-extension swmf-grammar-?.?.?.vsix
|
|
||||||
```
|
|
||||||
|
|
||||||
To test the installation, open the current folder in VS Code
|
|
||||||
|
|
||||||
```bash
|
|
||||||
code .
|
|
||||||
```
|
|
||||||
|
|
||||||
and view the file `demo.in`.
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user