readme
This commit is contained in:
		
							parent
							
								
									bd5f269955
								
							
						
					
					
						commit
						cd4eadea87
					
				
							
								
								
									
										28
									
								
								README.md
								
								
								
								
							
							
						
						
									
										28
									
								
								README.md
								
								
								
								
							| 
						 | 
				
			
			@ -39,19 +39,20 @@ Neovim's configurations are located under the following paths, depending on your
 | 
			
		|||
 | 
			
		||||
Clone kickstart.nvim:
 | 
			
		||||
 | 
			
		||||
- on Linux and Mac
 | 
			
		||||
```sh
 | 
			
		||||
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
 | 
			
		||||
# on Linux and Mac
 | 
			
		||||
git clone https://github.com/SevenDeLeven/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
- on Windows (cmd)
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\ 
 | 
			
		||||
# on Windows (cmd)
 | 
			
		||||
git clone https://github.com/SevenDeLeven/kickstart.nvim.git %userprofile%\AppData\Local\nvim\ 
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
- on Windows (powershell)
 | 
			
		||||
```
 | 
			
		||||
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\ 
 | 
			
		||||
# on Windows (powershell)
 | 
			
		||||
git clone https://github.com/SevenDeLeven/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\ 
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -71,10 +72,6 @@ If you would prefer to hide this step and run the plugin sync from the command l
 | 
			
		|||
nvim --headless "+Lazy! sync" +qa
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Getting Started
 | 
			
		||||
 | 
			
		||||
See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon.
 | 
			
		||||
 | 
			
		||||
### 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.
 | 
			
		||||
| 
						 | 
				
			
			@ -160,13 +157,17 @@ Each PR, especially those which increase the line count, should have a descripti
 | 
			
		|||
  * This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
 | 
			
		||||
  * You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide)
 | 
			
		||||
* Can I keep my existing configuration in parallel to kickstart?
 | 
			
		||||
  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
 | 
			
		||||
  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create a script `~/bin/nvim-kickstart`:
 | 
			
		||||
    ```
 | 
			
		||||
    alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
 | 
			
		||||
    #!/bin/sh
 | 
			
		||||
    exec env NVIM_APPNAME=nvim-kickstart nvim "$@"
 | 
			
		||||
    ```
 | 
			
		||||
    When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
 | 
			
		||||
    When you run Neovim with `nvim-kickstart` it will use the alternative config directory and the matching local directory: `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
 | 
			
		||||
* What if I want to "uninstall" this configuration:
 | 
			
		||||
  * See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
 | 
			
		||||
* Are there any cool videos about this plugin?
 | 
			
		||||
  * Current iteration of kickstart (coming soon)
 | 
			
		||||
  * Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works as specified. Please follow the install instructions in this file instead as they're up to date.
 | 
			
		||||
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
 | 
			
		||||
  * The main purpose of kickstart is to serve as a teaching tool and a reference
 | 
			
		||||
    configuration that someone can easily `git clone` as a basis for their own.
 | 
			
		||||
| 
						 | 
				
			
			@ -191,4 +192,3 @@ This requires:
 | 
			
		|||
```lua
 | 
			
		||||
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue