Installation Guide for Windows - Lazy.nvim

[jwhite510]

Issues

• I have checked existing issues and there are no existing ones with the same request.

Feature description

using Linux, minor issues getting it setup, had to install some packages through package manager, pretty straight forward. Then I wanted to get it working on windows. process was quite difficult, and i found a lack of information on how to do this. These are the steps I followed to get it working on windows. Please consider these steps I took here to get it working in my case, and update documentation to give a guide for windows.

Download neovim
-- download neovim for windows - note I am using the .zip version to create a portable neovim instance
-- https://github.com/neovim/neovim/releases/tag/v0.12.4

Lua setup
-- download lua for windows kit
-- https://github.com/rjpcomputing/luaforwindows/releases
-- run the installer

Download treesitter cli for windows
-- https://github.com/tree-sitter/tree-sitter/releases

Download lua rocks
-- https://luarocks.github.io/luarocks/releases/luarocks-3.13.0-windows-64.zip
-- even though this is included with the windows lua package and in my runtime path, lazy vim reports that it cant find it

Setup Cygwin
-- https://cygwin.com/setup-x86_64.exe
-- select the options to install the mingw/gcc compiler packages in cygwin

at this point when starting nvim when it's trying to compile the parser I get an error about linking a 64 bit executable to the 32 bit lua .dll

  5.1\lib\lua5.1.dll' is incompatible with i386:x86-64 output
  collect2: error: ld returned 1 exit status

replace the lua5.1.dll with the lua51.dll that comes in the neovim bin path

in the lua package path:

  5.1\lib\lua5.1.dll
  5.1\lib\lua5.1.lib
  5.1\lib\lua51.dll
  5.1\lib\lua51.lib

replace the contents of this folder with the .dll from the bin folder of neovim, alongside nvim.exe
move and (rename) lua51.dll (from nvim bin path) to
to 5.1\lib\lua5.1.dll in the lua for windows folder.

  bin\nvim.exe
  bin\lua51.dll --> 5.1\lib\lua5.1.dll

finally my command to run neovim looks like this:
run.cmd

:: NOTE: replaced lua5.1.dll with lua51.dll from nvim-win64/bin/lib51.dll
set "PATH=C:\Your\LuaforWindows\Path\5.1;%PATH%"
set "PATH=C:\Your\TreeSitter\Path\tree-sitter-cli-windows-x64;%PATH%"
set "PATH=C:\Your\LuaRocks\Path\luarocks-3.13.0-windows-64;%PATH%"
set "PATH=C:\Your\CygWin\Path\Cygwin\bin;%PATH%"
".\nvim.exe"

init.lua

require("lazy").setup({
  spec = {
    {
      "nvim-neorg/neorg",
      lazy = false,
      version = "*",
      dependencies = {
	    'nvim-neorg/tree-sitter-norg',
	    'nvim-neorg/tree-sitter-norg-meta',
      },
      config = function()
        require("neorg").setup({
         -- your setup options
        })
      end,
    },
  },
  install = { colorscheme = { "habamax" } },
  checker = { enabled = true },
})

Help

Yes

Implementation help

No response