zeeclor/kickstart.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
mgua 2023-04-26 09:58:15 +02:00 committed by GitHub
parent 2bd4ffba29
commit a76d46b800
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -69,60 +69,33 @@ Actions to be executed from administrator user:
2. Winget package manager installation ( see https://learn.microsoft.com/en-us/windows/package-manager/winget/ )
- install winget from microsoft store
3. from an administrator console, execute:
- winget install gnuwin32.tar
tar (bsdtar, installed in c:\Windows\WinSxS\.. c:\cygwin64\bin...)
- winget install gnuwin32.findutils
(grep)
- winget install Microsoft.WindowsTerminal
(if not from winget, it can be installed from microsoft https://aka.ms/terminal https://github.com/microsoft/terminal#other-install-methods https://github.com/microsoft/terminal (go on releases on right side...))
- choco install less bat gzip ripgrep grep fd fzf far netcat curl wget procexp mingw
(choco installs the tools in c:\ProgramData\chocolatey\bin these tools are needed for lsp config)
- nerdfonts are a nice to have extension. After font installation, they can be setup in Windows Terminal to be available for neovim interface.
- go download nerdfonts https://github.com/ryanoasis/nerd-fonts/releases/download/v2.3.3/Hack.zip uncompress in a temporary folder. then select all the .ttf files and press right-click then install
- Open MS terminal, press the top icon on the right of the "+", then choose Profile/Defaults on the left, then Appearance and in font face set Hack Nerd Font
- (for python development): choco install python
- (for perl development): winget install StrawberryPerl.StrawberryPerl (then close and reopen shell)
- (for perl development): cpanm -n Neovim::Ext (or cpan install Neovim::Ext)
- winget install gnuwin32.tar (bsdtar, installed in c:\Windows\WinSxS\.. c:\cygwin64\bin...)
- winget install gnuwin32.findutils (grep)
- winget install Microsoft.WindowsTerminal (if not from winget, it can be installed from microsoft https://aka.ms/terminal https://github.com/microsoft/terminal#other-install-methods https://github.com/microsoft/terminal (go on releases on right side...))
- choco install less bat gzip ripgrep grep fd fzf far netcat curl wget procexp mingw (choco installs the tools in c:\ProgramData\chocolatey\bin these tools are needed for lsp config)
- nerdfonts are a nice to have extension. After font installation, they can be setup in Windows Terminal to be available for neovim interface. Go download nerdfonts https://github.com/ryanoasis/nerd-fonts/releases/download/v2.3.3/Hack.zip uncompress in a temporary folder. then select all the .ttf files and press right-click then install. Open MS terminal, press the top icon on the right of the "+", then choose Profile/Defaults on the left, then Appearance and in font face set Hack Nerd Font
- choco install python (for python development. (I experienced path issues when using python.org install, maybe due to Anaconda being on my system too))
- winget install StrawberryPerl.StrawberryPerl (for perl development)
- cpanm -n Neovim::Ext (or cpan install Neovim::Ext) (for perl development)
### Neovim Kickstart Configuration for Windows (in non privileged user context)
(TBC)
- cd %HOMEPATH% (typically c:\Users\<your-username>\)
- py -m venv venv_nvim (for python development, we create a dedicated environment for nvim)
- .\venv_nvim\Scripts\activate (for python)
- py -m pip install pip --upgrade (for python, upgrade pip)
- py -m pip install neovim (for python, install neovim python package)
- mkdir %HOMEPATH%\AppData\Local\nvim\ (to avoid some path not found error)
- mkdir %HOMEPATH%\AppData\Local\Temp\nvim\ (to avoid some path not found error from lsp)
- Exit from nvim if open
- cd $HOME/App.config
- mv nvim nvim_old
- cd %HOMEPATH%\AppData\Local\
- ren nvim nvim_old
- mkdir nvim
- cd nvim
- git clone https://github.com/mgua/kickstart.nvim.git .
--
Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
* Backup your previous configuration
* (Recommended) Fork this repo (so that you have your own copy that you can modify).
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `~/AppData/Local/nvim/` (Windows)
* If you don't want to include it as a git repo, you can just clone it and then move the files to this location
* Start Neovim (`nvim`) and allow `lazy.nvim` to complete installation.
* Restart Neovim
* **You're ready to go!**
Additional system requirements:
- Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
- See as well [Windows Installation](#Windows-Installation)
### Configuration And Extension
* Inside of your fork, feel free to modify any file you like! It's your fork!
* Then there are two primary configuration options available:
* Include the `lua/kickstart/plugins/*` files in your configuration.
* Add new configuration in `lua/custom/plugins/*` files, which will be auto sourced using `lazy.nvim`
* NOTE: To enable this, you need to uncomment `{ import = 'custom.plugins' }` in your `init.lua`
You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration
#### Example: Adding an autopairs plugin
In the file: `lua/custom/plugins/autopairs.lua`, add: