Skip to content

Commit 9676339

Browse files
authored
Merge pull request #3 from fdncred/main
updated readme
2 parents d02029e + ae76ae0 commit 9676339

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,33 @@ for [Nushell](http://nushell.sh), a data driven document language.
66

77
## Features
88

9-
* Syntax highlighting
10-
* Auto-indentation
9+
* Syntax highlighting grammar
10+
* Nushell theme that tries to match Nushell's coloring
1111

1212
## Known Issues
1313

1414
See [our Github repository](https://github.com/nushell/vscode-nushell-lang)
1515
for active issues.
1616

17+
## Regex Engine
18+
19+
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.
20+
21+
## Build Process
22+
23+
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.
24+
25+
To summarize:
26+
1. npm install -g yo generator-code
27+
2. yo code
28+
3. chose `New Language Support` and filled out the rest of the questions
29+
4. npm install -g vsce
30+
5. update the readme and package.json
31+
6. vsce package
32+
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+
34+
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.
35+
36+
## Help
37+
38+
We are happily accepting pull requests to make this better. :)

0 commit comments

Comments
 (0)