Skip to content

Commit 04b5aef

Browse files
authored
Update README.md
1 parent e4223d1 commit 04b5aef

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,29 @@ Nushell syntax highlighting and indentation for Vim
33

44
## Installation
55
* create the ~/.vim directory and required subdirectories if they do not already exist
6-
7-
`mkdir -p ~/.vim/ftdetect && mkdir -p ~/.vim/ftplugin && mkdir -p ~/.vim/syntax`
6+
```
7+
mkdir -p ~/.vim/ftdetect && mkdir -p ~/.vim/ftplugin && mkdir -p ~/.vim/syntax
8+
```
89

910
* copy the .vim-files to their corresponding directories in ~/.vim
1011
* restart vim, if necessary
1112

13+
## Installation using Nushell script (experimental)
14+
* requires 'nu' to be in your PATH
15+
* use at your own risk
16+
* tested with Nushell 0.86.0 on Debian 12
17+
18+
```
19+
git clone "https://github.com/elkasztano/nushell-syntax-vim"
20+
cd nushell-syntax-vim
21+
nu ./install.nu
22+
```
23+
24+
to uninstall navigate to the 'nushell-syntax-vim' directory, then type
25+
```
26+
nu ./uninstall.nu
27+
```
28+
1229
## Notes
1330
I am new to both Nushell and Vimscript, and I am currently learning both at the same time. Please bear in mind that this little project is still very much work in progress. I couldn't find a way to get Nushell syntax highlighting in Vim, so I decided to implement it myself.
1431
Suggestions for improvement are highly appreciated.

0 commit comments

Comments
 (0)