Skip to content

Commit e504b3d

Browse files
authored
Merge pull request #13 from waldyrious/patch-1
README: various improvements
2 parents 2d642fd + b80276a commit e504b3d

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
1-
# vscode-nushell-lang README
1+
# vscode-nushell-lang VSCode extension
22

3-
This extension provides editing and syntax highlighting support
4-
for [Nushell](http://nushell.sh), a data driven document language.
3+
This [extension for VSCode](https://code.visualstudio.com/docs/introvideos/extend) provides editing and syntax highlighting support for [Nushell](http://nushell.sh), a data-driven document language.
54

65
## Features
76

8-
* Syntax highlighting grammar
7+
* Syntax highlighting grammar for Nushell scripts (`.nu` files)
98
* Nushell theme that tries to match Nushell's coloring
109

1110
## Screenshot (v0.0.4)
11+
1212
With Nushell Color Theme
13-
![](004-nushell.png)
13+
![Nushell script with Nushell color theme](004-nushell.png)
1414
With VSDark+ Color Theme
15-
![](004-vsdark.png)
15+
![Nushell script with VSDark+ color theme](004-vsdark.png)
1616

1717
## Known Issues
1818

19-
See [our Github repository](https://github.com/nushell/vscode-nushell-lang/issues)
20-
for active issues.
19+
See [our Github repository](https://github.com/nushell/vscode-nushell-lang/issues) for active issues.
2120

2221
## Regex Engine
2322

24-
VSCode uses a regular expressions that is based on Ruby for syntax highlighting. [This is a good site](https://rubular.com/) to test and try out these regular expressions.
23+
VSCode uses a regular expressions engine that is based on Ruby for syntax highlighting.
24+
[This is a good site](https://rubular.com/) to test and try out these regular expressions.
2525

2626
## Build Process
2727

28-
We pretty much followed [these instructions](https://code.visualstudio.com/api/get-started/your-first-extension) for building this extension. And [this link](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) for packaging the extension.
28+
We pretty much followed [these instructions](https://code.visualstudio.com/api/get-started/your-first-extension) for building this extension.
29+
And [this link](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) for packaging the extension.
30+
31+
To summarize, the steps were:
2932

30-
To summarize:
31-
1. npm install -g yo generator-code
32-
2. yo code
33-
3. chose `New Language Support` and filled out the rest of the questions
34-
4. npm install -g vsce
35-
5. update the readme and package.json
36-
6. vsce package
37-
7. code --install-extension vscode-nushell-lang-0.0.2.vsix or alternatively you can do ctrl/cmd-shift-p Extensions:Install From VSIX...
33+
1. `npm install -g yo generator-code`
34+
2. `yo code`
35+
3. choose "New Language Support" and fill out the rest of the questions
36+
4. `npm install -g vsce`
37+
5. update the `README.md` and `package.json`
38+
6. `vsce package`
39+
7. `code --install-extension vscode-nushell-lang-0.0.2.vsix`<br/>
40+
(Alternatively, you can do <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>-<kbd>Shift</kbd>-<kbd>P</kbd> and type "Extensions:Install From VSIX...")
3841

39-
If you have all these tools already installed you should be able to clone this repo and just do a `vsce package` to get a vsix file that you can install in vscode.
42+
If you have all these tools already installed, you should be able to clone this repo and just run `vsce package` to get a `.vsix` file that you can install in vscode.
4043

4144
## Help
4245

43-
We are happily accepting pull requests to make this better. :)
46+
We are happily accepting pull requests to make this better. :)

0 commit comments

Comments
 (0)