Skip to content

Commit de800d5

Browse files
committed
add demo + update readme
1 parent 1d9d9fe commit de800d5

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
# LuaSnip-LaTeX-Snippets
22

3-
A set of preconfigured snippets for LaTeX for the snippet engine LuaSnip.
3+
A set of preconfigured snippets for LaTeX for the snippet engine [LuaSnip](https://github.com/L3MON4D3/LuaSnip).
44

5-
**Warning:** This is currently *not* working as something to install right out of the box.
5+
![demo](/assets/demo.mp4)
66

7-
Ideally would like to expand this to more languages, allow for better user experience in the future; feel free to make a PR to help contribute your own ideas.
7+
## Installation
8+
9+
Use the package manager of your choice, or don't.
10+
11+
**Lazy.nvim**
12+
```lua
13+
{
14+
"evesdropper/luasnip-latex-snippets.nvim",
15+
},
16+
```
17+
18+
**Packer.nvim**
19+
```lua
20+
use {
21+
"evesdropper/luasnip-latex-snippets.nvim",
22+
},
23+
```
24+
25+
## Development Plans
26+
27+
Of course, add more snippets. Ideally would also like to expand this to more languages, allow for better user experience in the future; feel free to make a PR to help contribute your own ideas.
828

929
## Acknowledgements
1030
Some similar snippet resources:
1131
- [friendly-snippets](https://github.com/rafamadriz/friendly-snippets/)
1232
- [LuaSnip-snippets.nvim](https://github.com/molleweide/LuaSnip-snippets.nvim)
1333
- [Gilles Castel's LaTeX Snippets](https://github.com/gillescastel/latex-snippets)
1434

15-
Additionally, I would like to thank Max Mehta for bringing up the idea of creating this plugin.
35+
Additionally, I would like to thank Max Mehta for bringing up the idea of creating this plugin and the creator of LuaSnip, [L3MON4D3](https://github.com/L3MON4D3), for helping me debug some of the early stages of the plugin.

assets/demo.mp4

1.56 MB
Binary file not shown.

0 commit comments

Comments
 (0)