Skip to content

Commit

Permalink
Added installation instructions for VSCode and vim/nvim.
Browse files Browse the repository at this point in the history
  • Loading branch information
Thierry Delafontaine committed Mar 3, 2022
1 parent 10930a4 commit 8256745
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,49 @@ Currently, this collection provides snippets for the InES file headers in C/C++
and VHDL. More snippets will be added when they get requested or I when I
encounter them.

## Installation

### VSCode

Install the extension from the extension market.

### Vim/Neovim
This plugin only provides snippets. Therefore, you need a plugin that provides
snippet features and supports loading VSCode snippets.

For example:

- [vim-vsnip](https://github.com/hrsh7th/vim-vsnip)
- [LuaSnip](https://github.com/L3MON4D3/LuaSnip)
- [coc-snippets](https://github.com/neoclide/coc-snippets)

Use your plugin manager to install the package.

```lua
-- Packer
use "rafamadriz/friendly-snippets"
```

```vim
-- Plug
Plug 'rafamadriz/friendly-snippets'
```

```
-- coc.nvim
CocInstall https://github.com/InES-HPMM/zhaw-snippets@main
```

[vim-vsnip](https://github.com/hrsh7th/vim-vsnip) will automatically detect and
load the snippets. In [LuaSnip](https://github.com/L3MON4D3/LuaSnip) you will
have to call

```lua
require("luasnip.loaders.from_vscode").load()
-- or to lazy load the snippets
require("luasnip.loaders.from_vscode").lazy_load()
```

## Snippets

| Snippet | Purpose | Available in |
Expand Down

0 comments on commit 8256745

Please sign in to comment.