emkat
/
nvim-config
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add instructions for TreeSitter and clarify LuaRocks requirements

This commit is contained in:
Emma Turner 2025-11-17 16:59:35 -07:00
parent 55d4d25f6e
commit dc18881a6d
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -5,22 +5,35 @@ Refer to the [documentation](https://lazyvim.github.io/installation) to learn mo
## Setup
A c compiler is required to install treesitter parsers. Currently using gcc from the 64-bit win32 ucrt version of Mingw.
### Treesitter
A c compiler and the tree-sitter cli are required to install treesitter parsers.
#### C Compiler
Currently using gcc from the 64-bit win32 ucrt version of Mingw.
This can be installed from [https://github.com/niXman/mingw-builds-binaries/releases]
The `mingw64` folder will need to be "installed" (ex. moved to `C:\ProgramData\`) and added to the path for neovim to use it.
#### tree-sitter cli
1. Download the tree-sitter cli from [https://github.com/tree-sitter/tree-sitter/releases]
2. "Install" the cli (currently in `C:\tools\`)
3. Add the cli to the PATH
### LuaRocks
Neorg currently require LuaRocks to install properly.
LazyVim currently requires LuaRocks to install properly.
To install:
1. Install Lua from LuaForWindows [https://github.com/rjpcomputing/luaforwindows]
2. Install standalone (64-bit) LuaRocks [https://luarocks.github.io/luarocks/releases/]
2. "Install" standalone (64-bit) LuaRocks (currently in `C:\tools\`) [https://luarocks.github.io/luarocks/releases/]
- [Instructions](https://github.com/luarocks/luarocks/blob/main/docs/installation_instructions_for_windows.md)
3. Add LuaRocks to the PATH
_Note: If LuaRocks and tree-sitter cli are "installed" in the same location you will only need to edit the path once_
### Nerd Font
A "Nerd Font" is used to get the correct symbols used by LazyVim.