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

Merge pull request #422 from saccarosium/master

Browse Source 
Iterate over #420
This commit is contained in:
Chris Patti 2023-09-13 10:19:55 -04:00 committed by GitHub
commit 4b31f8ef9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -20,7 +20,7 @@ Distribution Alternatives:
### Installation ### Installation
> **NOTE** > **NOTE**
> [Backup](#FAQ) your previous configuration (if any exists) > [Backup](#FAQ) your previous configuration (if any exists)
Requirements: Requirements:
@ -32,24 +32,17 @@ Neovim's configurations are located under the following paths, depending on your
| OS | PATH | | OS | PATH |
| :- | :--- | | :- | :--- |
| Linux | `~/.config/nvim` | | Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| MacOS | `~/.config/nvim` | | MacOS | `$XDG_CONFIG_HOME/nvim`, '~/.config/nvim` |
| Windows | `%userprofile%\AppData\Local\nvim\` | | Windows | `%userprofile%\AppData\Local\nvim\` |
#### Archive Installation Clone kickstart.nvim:
* On the home/landing page for the project find the green "`<> CODE`" button click it and select `Local > Download ZIP`.
* Extract the archive to the appropriate configuration path.
* Ensure your extraction method did not extract with a parent folder. For example in `~/.config/nvim` you should have `init.lua` not another folder called `kickstart.nvim`.
#### Git Clone Installation
From a terminal `cd`/`dir` to the configuration path and then run:
```sh ```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git ~/.config/nvim # on Linux and Mac
# OR git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
gh repo clone nvim-lua/kickstart.nvim # on Windows
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
``` ```
### Post Installation ### Post Installation
@ -60,7 +53,7 @@ Run the following command and then **you are ready to go**!
nvim --headless "+Lazy! sync" +qa nvim --headless "+Lazy! sync" +qa
``` ```
### Recommended Optional ### 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.