Skip to content
Yefer YV edited this page Aug 27, 2024 · 6 revisions

TERMINAL DEPENDENCIES (optional):

Dependencies Description
zig to compile treesitter parsers on Windows 10/11 (compiling with gcc doesn't support treesitter highlight on Windows 10/11)
git required if you want to install retronvim from source
eza ls with icons
FiraCode font ligatures + yazi icons + neovim icons
fzf search files inside yazi and search history in zsh
karabiner-elements required by kanata on macos
lazygit git UI in the terminal
Msys2 unix commands/shell for Windows 10/11
npm used by mason.nvim
ripdrag drag and drop files from yazi (only supports linux by now)
starship zsh prompt with git support
zsh posix compliant shell with syntax-highlighting + suggestions support

RetroNvim is shipped with:

Dependencies Description shipped as
vcredist2022 library required by neovim and yazi on Windows 10/11 .dll
neovim mini.completion requires version >= v0.11 binary
yazi terminal file manager binary
kanata keyboard layout with vim-like arrow keys binary
zsh-fast-syntax-highlighting zsh plugin git-submodule
zsh-autosuggestions zsh plugin git-submodule
bookmarks-persistence.yazi yazi plugin git-submodule

Neovim extensions (shipped as git-submodule inside RetroNvim):

Neovim dependency Description only inside
codeium.nvim AI suggestions (run :Codeium Auth then :Codeium Enable) neovim
flash.nvim search with labels
friendly-snippets snippets collection for a set of different programming languages neovim
gitsigns.nvim edit/preview git changes neovim
luasnip snippet engine neovim
mason.nvim LSP/linter/formatter binary installer neovim
mason-lspconfig.nvim compatibility between mason and nvim-lspconfig neovim
mason-null-ls.nvim compatibility between mason and none-ls neovim
mini.nvim library of 40+ independent Lua modules
none-ls.nvim default configurations for formatters and linters neovim
nvim-lspconfig default configurations for LSP neovim
nvim-treesitter required by nvim-treesitter-textobjects
nvim-treesitter-textobjects Syntax aware text-objects
nvim-various-textobjs text objects based on regex
plenary.nvim lua modules required by none-ls neovim

Modules used which are part of mini.nvim extension

Module Description Overview Details
mini.ai Extend and create a/i textobjects README Help file
mini.align Align text interactively README Help file
mini.base16 Base16 colorscheme creation README Help file
mini.bracketed Go forward/backward with square brackets README Help file
mini.clue Show next key clues README Help file
mini.comment Comment lines README Help file
mini.completion Completion and signature help README Help file
mini.cursorword Autohighlight word under cursor README Help file
mini.deps Plugin manager README Help file
mini.extra Extra 'mini.nvim' functionality README Help file
mini.files Navigate and manipulate file system README Help file
mini.icons Icon provider README Help file
mini.indentscope Visualize and work with indent scope README Help file
mini.misc Miscellaneous functions README Help file
mini.notify Show notifications README Help file
mini.operators Text edit operators README Help file
mini.pairs Autopairs README Help file
mini.pick Pick anything README Help file
mini.splitjoin Split and join arguments README Help file
mini.statusline Statusline README Help file
mini.starter Start screen README Help file
mini.surround Surround actions README Help file
mini.tabline Tabline README Help file

Windows10 Setup

-> open whichkey > +Install dependencies > Install Scoop (Windows 10/11) > scoop install neovim...

-> relaunch vscode

-> reopen whichkey > +Install dependencies > Increase keyboard repeat rate on Windows 10/11 > start touchcursor keyboard layout...

Linux Setup

-> open whichkey > +Install dependencies > install nixpkgs (Linux) > nixpkgs install neovim...

-> relaunch vscode

-> reopen whichkey > +Install dependencies > start touchcursor keyboard layout...

MacOS Setup

-> open whichkey > +Install dependencies > install brew (MacOS) > brew install neovim...

-> relaunch vscode

-> reopen whichkey > +Install dependencies > Increase keyboard repeat rate on MacOS > start touchcursor keyboard layout...

Clone this wiki locally