mirror
/
kickstart.nvim
mirror of https://github.com/nvim-lua/kickstart.nvim.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

chore: updated readme

This commit is contained in:
stephansama 2026-05-28 04:07:22 -04:00
parent cfdc17be3a
commit f1de74680a
No known key found for this signature in database
GPG Key ID: 4B38234D51C44328
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -61,23 +61,26 @@ Neovim's configurations are located under the following paths, depending on your
#### Recommended Step #### Recommended Step
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo Create your own copy of this repo using GitHub's
so that you have your own copy that you can modify, then install by cloning the ["Use this template"](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
fork to your machine using one of the commands below, depending on your OS. button so that you have your own copy that you can modify, then install by
cloning your new repo to your machine using one of the commands below,
depending on your OS.
> [!NOTE] > [!NOTE]
> Your fork's URL will be something like this: > Your repo's URL will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git` > `https://github.com/<your_github_username>/kickstart.nvim.git`
You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore` You likely want to remove `nvim-pack-lock.json` from your repo's `.gitignore`
file too - it's ignored in the kickstart repo to make maintenance easier, but file too - it's ignored in the kickstart repo to make maintenance easier, but
it's recommended to track it in version control (see `:help vim.pack-lockfile`). it's recommended to track it in version control (see `:help vim.pack-lockfile`).
#### Clone kickstart.nvim #### Clone kickstart.nvim
> [!NOTE] > [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace > If following the recommended step above (i.e., creating your own repo from
> `nvim-lua` with `<your_github_username>` in the commands below > the template), replace `nvim-lua` with `<your_github_username>` in the
> commands below
<details><summary> Linux and Mac </summary> <details><summary> Linux and Mac </summary>