Merge pull request #420 from saccarosium/master
docs: restructure README
This commit is contained in:
		
						commit
						c80a77488b
					
				
							
								
								
									
										65
									
								
								README.md
								
								
								
								
							
							
						
						
									
										65
									
								
								README.md
								
								
								
								
							|  | @ -20,35 +20,52 @@ Distribution Alternatives: | ||||||
| 
 | 
 | ||||||
| ### Installation | ### Installation | ||||||
| 
 | 
 | ||||||
| * Backup your previous configuration (if any exists) | > **NOTE**   | ||||||
|  | > [Backup](#FAQ) your previous configuration (if any exists) | ||||||
| 
 | 
 | ||||||
| ### Archive Installation | Requirements: | ||||||
| * On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP. | * Make sure to review the readmes of the plugins if you are experiencing errors. In particular: | ||||||
| * Extract the archive to: |   * [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers. | ||||||
|   `~/.config/nvim` (Linux) | * See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native` | ||||||
|   `~/.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 | Neovim's configurations are located under the following paths, depending on your OS: | ||||||
| * 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` | | OS | PATH | | ||||||
| * 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. | | Linux | `~/.config/nvim` | | ||||||
| * **You're ready to go!** | | MacOS | `~/.config/nvim` | | ||||||
|  | | Windows | `%userprofile%\AppData\Local\nvim\` | | ||||||
| 
 | 
 | ||||||
| * (Recommended/Optional) Fork this repo (so that you have your own copy that you can modify). | #### Archive Installation | ||||||
| * 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: | * On the home/landing page for the project find the green "`<> CODE`" button click it and select `Local > Download ZIP`. | ||||||
| - Make sure to review the readmes of the plugins if you are experiencing errors. In particular: | * Extract the archive to the appropriate configuration path. | ||||||
|   - [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers. | * 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`. | ||||||
| - See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native` | 
 | ||||||
|  | #### 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 | ### Configuration And Extension | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	 Chris Patti
						Chris Patti