summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuca Saccarola <github.e41mv@aleeas.com>2023-09-05 14:12:56 +0200
committerLuca Saccarola <github.e41mv@aleeas.com>2023-09-05 14:24:39 +0200
commitf3f6a595a27af4a1762d5623ca9e8ce49b02e915 (patch)
treede4d27545cfb5e1f0461bb69c77d777a76bd834d
parent1a971cbdcffdc204e073d8142e5491e1f976a3eb (diff)
docs: restructure README
-rw-r--r--README.md75
1 files changed, 46 insertions, 29 deletions
diff --git a/README.md b/README.md
index 4a312bc..963883d 100644
--- a/README.md
+++ b/README.md
@@ -20,35 +20,52 @@ Distribution Alternatives:
### Installation
-* Backup your previous configuration (if any exists)
-
-### 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)
- `~/.config/nvim` (MacOS)
- `%userprofile%\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.
-
-### Git Clone Installation
-* From a terminal cd/dir to:
- `~/.config/nvim` (Linux)
- `~/.config/nvim` (MacOS)
- `%userprofile%\AppData\Local\nvim\` (Windows)
-
-* Run: `git clone https://github.com/nvim-lua/kickstart.nvim.git ~/.config/nvim` OR: `gh repo clone nvim-lua/kickstart.nvim`
-* Run Neovim (from terminal or shortcut) and allow lazy.nvim to download files and set up the basics.
-* Once the setup is complete, restart Neovim.
-* **You're ready to go!**
-
-* (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 `%userprofile%\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
-
-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 [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
+> **NOTE**
+> [Backup](#FAQ) your previous configuration (if any exists)
+
+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 [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
+
+Neovim's configurations are located under the following paths, depending on your OS:
+
+| OS | PATH |
+| :- | :--- |
+| Linux | `~/.config/nvim` |
+| MacOS | `~/.config/nvim` |
+| Windows | `%userprofile%\AppData\Local\nvim\` |
+
+#### Archive Installation
+
+* 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
+git clone https://github.com/nvim-lua/kickstart.nvim.git ~/.config/nvim
+# OR
+gh repo clone nvim-lua/kickstart.nvim
+```
+
+### Post Installation
+
+Run the following command and then **you are ready to go**!
+
+```sh
+nvim --headless "+Lazy! sync" +qa
+```
+
+### Recommended Optional
+
+[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**
+> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
### Configuration And Extension