mirror of
https://github.com/LhKipp/nvim-nu
synced 2024-09-16 14:24:01 +02:00
Update README.md
This commit is contained in:
parent
c57022a408
commit
3ef0193998
2 changed files with 16 additions and 2 deletions
18
README.md
18
README.md
|
@ -4,7 +4,7 @@
|
|||
|
||||
---
|
||||
|
||||
**Warning: This plugin uses a [tree-sitter grammar](https://github.com/LhKipp/tree-sitter-nu) made for nu version ~0.45. As nushell evolves quickly, the tree-sitter plugin might be outdated by now, resulting in poor tree-sitter related functionality (highlighting, code-folding, ...). PR's are welcome**
|
||||
**Info: This plugin was made for nu version ~0.45. As nushell evolves quickly, the plugin might not work perfectly for later versions. PR's are welcome**
|
||||
|
||||
---
|
||||
|
||||
|
@ -12,14 +12,15 @@
|
|||
|
||||
* [Requirements](#requirements)
|
||||
* [Installation](#installation)
|
||||
* [Configuration](#installation)
|
||||
---
|
||||
|
||||
# Requirements
|
||||
|
||||
- Neovim version >= 0.5
|
||||
- A [nu](https://github.com/nushell/nushell/releases) binary in your path
|
||||
- A C compiler in your path and libstdc++ installed ([Windows users please read this!](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Windows-support)).
|
||||
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter/blob/master/README.md#quickstart) installed
|
||||
- [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) if nu-command names shall be suggested
|
||||
|
||||
# Installation
|
||||
|
||||
|
@ -30,3 +31,16 @@ E.g., if you are using [vim-plug](https://github.com/junegunn/vim-plug), put thi
|
|||
```vim
|
||||
Plug 'LhKipp/nvim-nu', {'do': ':TSInstall nu'}
|
||||
```
|
||||
|
||||
Don't forget to call setup :smirk:
|
||||
```lua
|
||||
require('nu').setup{}
|
||||
```
|
||||
|
||||
## Configuration
|
||||
(Default values are shown)
|
||||
```lua
|
||||
require('nu').setup({
|
||||
complete_cmd_names = true, -- requires https://github.com/jose-elias-alvarez/null-ls.nvim
|
||||
})
|
||||
```
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 107 KiB |
Loading…
Reference in a new issue