summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornPHYN1T3 <38122105+nPHYN1T3@users.noreply.github.com>2023-04-24 15:28:27 -0600
committerGitHub <noreply@github.com>2023-04-24 15:28:27 -0600
commitb5c0b25398409465006732f1f29aafff73ee42af (patch)
treedc720d83b31f13c6478b1b9a2c841ea3a887ef8f /README.md
parent2eff982e1ef7b7c1e7a052c5338a4a09bec396cd (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/README.md b/README.md
index 52a62fc..29df719 100644
--- a/README.md
+++ b/README.md
@@ -23,21 +23,25 @@ Distribution Alternatives:
### Archive Installation
* On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP.
* Extract the archive to:
- ~/.config/nvim (Linux)
- ??? (MacOS)
- ??? (Windows)
+ `~/.config/nvim` (Linux)
+ `~/.config/nvim` (MacOS)
+ `~/AppData/Local/nvim/` (Windows)
* 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.
-* Run nvim and allow the kickstart process to download files and set up the basics.
### GIT Clone Installation
+* From a terminal cd/dir to:
+ `~/.config/nvim` (Linux)
+ `~/.config/nvim` (MacOS)
+ `~/AppData/Local/nvim/` (Windows)
+* run: git clone https://github.com/nvim-lua/kickstart.nvim.git OR: gh repo clone nvim-lua/kickstart.nvim
+
+* Run neovim (from terminal or shortcut) and allow the kickstart process to download files and set up the basics.
+* Once the setup is complete restart Neovim.
+* **You're ready to go!**
-
-* (Recommended) Fork this repo (so that you have your own copy that you can modify).
+* (Recommended/Optional) 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: