Skip to content

Commit cd4eade

Browse files
committed
readme
1 parent bd5f269 commit cd4eade

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,20 @@ Neovim's configurations are located under the following paths, depending on your
3939

4040
Clone kickstart.nvim:
4141

42-
- on Linux and Mac
4342
```sh
44-
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
43+
# on Linux and Mac
44+
git clone https://github.com/SevenDeLeven/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
4545
```
4646

47-
- on Windows (cmd)
47+
4848
```
49-
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
49+
# on Windows (cmd)
50+
git clone https://github.com/SevenDeLeven/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
5051
```
5152

52-
- on Windows (powershell)
5353
```
54-
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
54+
# on Windows (powershell)
55+
git clone https://github.com/SevenDeLeven/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
5556
```
5657

5758

@@ -71,10 +72,6 @@ If you would prefer to hide this step and run the plugin sync from the command l
7172
nvim --headless "+Lazy! sync" +qa
7273
```
7374

74-
### Getting Started
75-
76-
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.
77-
7875
### Recommended Steps
7976

8077
[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
160157
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
161158
* You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide)
162159
* Can I keep my existing configuration in parallel to kickstart?
163-
* 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:
160+
* 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`:
164161
```
165-
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
162+
#!/bin/sh
163+
exec env NVIM_APPNAME=nvim-kickstart nvim "$@"
166164
```
167-
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.
165+
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.
168166
* What if I want to "uninstall" this configuration:
169167
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
168+
* Are there any cool videos about this plugin?
169+
* Current iteration of kickstart (coming soon)
170+
* 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.
170171
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
171172
* The main purpose of kickstart is to serve as a teaching tool and a reference
172173
configuration that someone can easily `git clone` as a basis for their own.
@@ -191,4 +192,3 @@ This requires:
191192
```lua
192193
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
193194
```
194-

0 commit comments

Comments
 (0)