fixup: update docs and check deps

This commit is contained in:
TJ DeVries 2024-02-23 16:53:32 -05:00
parent 0f8eb177da
commit 51842d8064
2 changed files with 35 additions and 26 deletions

View file

@ -1,30 +1,39 @@
# kickstart.nvim # kickstart.nvim
### Introduction ## Introduction
A starting point for Neovim that is: A starting point for Neovim that is:
* Small * Small
* Single-file (with examples of moving to multi-file) * Single-file
* Documented * Completely Documented
* Modular
This repo is meant to be used by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss. **NOT** a Neovim distribution, but instead a starting point for your configuration.
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. ## Installation
Distribution Alternatives: ### Install Neovim
- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
### Installation 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.
### Install External Dependencies
> **NOTE** > **NOTE**
> [Backup](#FAQ) your previous configuration (if any exists) > [Backup](#FAQ) your previous configuration (if any exists)
Requirements: External Requirements:
* Make sure to review the readmes of the plugins if you are experiencing errors. In particular: - Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
* [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers. - [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
* See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native` - Language Setup:
- If want to write Typescript, you need `npm`
- If want to write Golang, you will need `go`
- etc.
> **NOTE**
> See [Windows Installation](#Windows-Installation) to double check any additional Windows notes
Neovim's configurations are located under the following paths, depending on your OS: Neovim's configurations are located under the following paths, depending on your OS:
@ -36,8 +45,7 @@ Neovim's configurations are located under the following paths, depending on your
Clone kickstart.nvim: Clone kickstart.nvim:
<details> <details><summary> Linux and Mac </summary>
<summary> Linux and Mac </summary>
```sh ```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
@ -45,8 +53,7 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
</details> </details>
<details> <details><summary> Windows </summary>
<summary> Windows </summary>
If you're using `cmd.exe`: If you're using `cmd.exe`:
@ -62,7 +69,6 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppDat
</details> </details>
### Post Installation ### Post Installation
Start Neovim Start Neovim
@ -71,17 +77,23 @@ Start Neovim
nvim nvim
``` ```
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view current plugin status. That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
current plugin status.
Read through the `init.lua` file in your configuration folder for more information about extending and exploring Neovim. Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim.
### Getting Started ### Getting Started
See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon. See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the
previous version. Note: The install via init.lua is outdated, please follow the
install instructions in this file instead. An updated video is coming soon.
### Recommended Steps ### Recommended Steps
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo (so that you have your own copy that you can modify) and then installing you can install to your machine using the methods above. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
(so that you have your own copy that you can modify) and then installing you
can install to your machine using the methods above.
> **NOTE** > **NOTE**
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git` > Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
@ -115,10 +127,7 @@ return {
} }
``` ```
</details> </details>
<details> <details>
<summary>Adding a file tree plugin</summary> <summary>Adding a file tree plugin</summary>

View file

@ -620,7 +620,7 @@ require('lazy').setup({
-- Build Step is needed for regex support in snippets -- Build Step is needed for regex support in snippets
-- This step is not supported in many windows environments -- This step is not supported in many windows environments
-- Remove the below condition to re-enable on windows -- Remove the below condition to re-enable on windows
if vim.fn.has 'win32' == 1 then if vim.fn.has 'win32' == 1 or vim.fn.executable 'make' == 0 then
return return
end end
return 'make install_jsregexp' return 'make install_jsregexp'