Skip to content

Commit 737fbbf

Browse files
petergipetergi
authored
Update README.md
1 parent 5aeddfd commit 737fbbf

File tree

1 file changed

+99
-138
lines changed

1 file changed

+99
-138
lines changed

‎README.md

Lines changed: 99 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -1,229 +1,190 @@
1-
# kickstart.nvim
1+
# KickInTheHead.nvim
22

33
## Introduction
44

5-
A starting point for Neovim that is:
5+
### A Kitchen Sink personal configuration for Neovim that is:
66

7-
* Small
8-
* Single-file
9-
* Completely Documented
7+
- Originally forked from Kickstart.nvim
8+
- NOT Small
9+
- NOT Single-file
10+
- PARTIALLY Documented
1011

11-
**NOT** a Neovim distribution, but instead a starting point for your configuration.
12+
*NOT* a Neovim distribution, but instead my attempt at creating my favorite frankenstein configuration for my own personal use.
13+
You're welcome to take it and do as you will, over even try to contribute back (if ain't got no other habits, why not?)
1214

1315
## Installation
1416

1517
### Install Neovim
1618

17-
Kickstart.nvim targets *only* the latest
18-
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
19-
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
19+
*KickInTheHead.nvim* targets only the latest
20+
'stable' and latest
21+
'nightly' of Neovim.
2022
If you are experiencing issues, please make sure you have the latest versions.
2123

2224
### Install External Dependencies
2325

24-
External Requirements:
25-
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
26-
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
26+
#### External Requirements:
27+
28+
- Basic utils: git, make, unzip, C Compiler (gcc)
29+
- ripgrep
2730
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
28-
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
29-
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
31+
- A Nerd Font: optional, provides various icons
32+
- if you have it set vim.g.have_nerd_font in init.lua to true
3033
- Language Setup:
31-
- If want to write Typescript, you need `npm`
32-
- If want to write Golang, you will need `go`
34+
- If want to write Typescript, you need npm
35+
- If want to write Golang, you will need go
3336
- etc.
3437

35-
> **NOTE**
36-
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
37-
> and quick install snippets
38+
*NOTE*
39+
See Install Recipes for additional Windows and Linux specific notes
40+
and quick install snippets
3841

39-
### Install Kickstart
42+
### Install KickInTheHead
4043

41-
> **NOTE**
42-
> [Backup](#FAQ) your previous configuration (if any exists)
44+
*NOTE*
45+
Backup your previous configuration (if any exists)
4346

4447
Neovim's configurations are located under the following paths, depending on your OS:
4548

46-
| OS | PATH |
47-
| :- | :--- |
48-
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
49-
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
50-
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
49+
OS PATH
50+
Linux, MacOS $XDG_CONFIG_HOME/nvim, ~/.config/nvim
51+
Windows (cmd) %userprofile%\AppData\Local\nvim\
52+
Windows (powershell) $env:USERPROFILE\AppData\Local\nvim\
5153

52-
#### Recommended Step
54+
Recommended Step
5355

54-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
56+
Fork this repo
5557
so that you have your own copy that you can modify, then install by cloning the
5658
fork to your machine using one of the commands below, depending on your OS.
5759

58-
> **NOTE**
59-
> Your fork's url will be something like this:
60-
> `https://github.com/<your_github_username>/kickstart.nvim.git`
60+
*NOTE*
61+
Your fork's url will be something like this:
62+
https://github.com/<your_github_username>/kickinthehead.nvim.git
63+
64+
Clone KickInTheHead.nvim
6165

62-
#### Clone kickstart.nvim
63-
> **NOTE**
64-
> If following the recommended step above (i.e., forking the repo), replace
65-
> `nvim-lua` with `<your_github_username>` in the commands below
66+
*NOTE*
67+
If following the recommended step above (i.e., forking the repo), replace
68+
petergi with <your_github_username> in the commands below
6669

6770
<details><summary> Linux and Mac </summary>
6871

69-
```sh
70-
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
71-
```
72+
git clone https://github.com/petergi/KickInTheHead.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
7273

7374
</details>
7475

7576
<details><summary> Windows </summary>
7677

77-
If you're using `cmd.exe`:
78+
If you're using cmd.exe:
7879

79-
```
80-
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
81-
```
80+
git clone https://github.com/petergi/KickInTheHead.nvim.git %userprofile%\AppData\Local\nvim\
8281

83-
If you're using `powershell.exe`
82+
If you're using powershell.exe
8483

85-
```
86-
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
87-
```
84+
git clone https://github.com/petergi/KickInTheHead.nvim.git $env:USERPROFILE\AppData\Local\nvim\
8885

8986
</details>
9087

91-
### Post Installation
88+
## Post Installation
9289

93-
Start Neovim
90+
### Start Neovim
9491

95-
```sh
96-
nvim
97-
```
92+
`nvim`
9893

99-
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
100-
current plugin status. Hit `q` to close the window.
94+
That's it! Lazy will install all the plugins you have configured. Use :Lazy to view
95+
current plugin status. Hit q to close the window.
10196

102-
Read through the `init.lua` file in your configuration folder for more
97+
Read through the CONFIGUREME.md file in your configuration folder for more
10398
information about extending and exploring Neovim. That also includes
10499
examples of adding popularly requested plugins.
105100

101+
## Getting Started
102+
103+
The Only Video You Need to Get Started with Neovim
106104

107-
### Getting Started
108-
109-
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
110-
111-
### FAQ
112-
113-
* What should I do if I already have a pre-existing neovim configuration?
114-
* You should back it up and then delete all associated files.
115-
* This includes your existing init.lua and the neovim files in `~/.local`
116-
which can be deleted with `rm -rf ~/.local/share/nvim/`
117-
* Can I keep my existing configuration in parallel to kickstart?
118-
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
119-
to maintain multiple configurations. For example, you can install the kickstart
120-
configuration in `~/.config/nvim-kickstart` and create an alias:
121-
```
122-
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
123-
```
124-
When you run Neovim using `nvim-kickstart` alias it will use the alternative
125-
config directory and the matching local directory
126-
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
127-
distribution that you would like to try out.
128-
* What if I want to "uninstall" this configuration:
129-
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
130-
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
131-
* The main purpose of kickstart is to serve as a teaching tool and a reference
132-
configuration that someone can easily use to `git clone` as a basis for their own.
133-
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
134-
into smaller parts. A fork of kickstart that does this while maintaining the
135-
same functionality is available here:
136-
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
137-
* Discussions on this topic can be found here:
138-
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
139-
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
140-
141-
### Install Recipes
105+
## Install Recipes
142106

143107
Below you can find OS specific install instructions for Neovim and dependencies.
144108

145-
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
109+
After installing all the dependencies continue with the Install KickInTheHead step.
146110

147-
#### Windows Installation
111+
### Windows Installation
148112

149113
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
150114
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
151115

152-
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
116+
See telescope-fzf-native documentation for more details
153117

154118
This requires:
155119

156120
- Install CMake and the Microsoft C++ Build Tools on Windows
157121

158-
```lua
159-
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
160-
```
122+
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
123+
161124
</details>
125+
162126
<details><summary>Windows with gcc/make using chocolatey</summary>
163127
Alternatively, one can install gcc and make which don't require changing the config,
164128
the easiest way is to use choco:
165129

166-
1. install [chocolatey](https://chocolatey.org/install)
130+
1. install chocolatey
167131
either follow the instructions on the page or use winget,
168-
run in cmd as **admin**:
169-
```
170-
winget install --accept-source-agreements chocolatey.chocolatey
171-
```
132+
run in cmd as admin:
133+
134+
winget install --accept-source-agreements chocolatey.chocolatey
172135

173136
2. install all requirements using choco, exit previous cmd and
174-
open a new one so that choco path is set, and run in cmd as **admin**:
175-
```
176-
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
177-
```
137+
open a new one so that choco path is set, and run in cmd as admin:
138+
139+
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
140+
178141
</details>
142+
179143
<details><summary>WSL (Windows Subsystem for Linux)</summary>
180144

181-
```
182-
wsl --install
183-
wsl
184-
sudo add-apt-repository ppa:neovim-ppa/unstable -y
185-
sudo apt update
186-
sudo apt install make gcc ripgrep unzip git xclip neovim
187-
```
145+
wsl --install
146+
wsl
147+
sudo add-apt-repository ppa:neovim-ppa/unstable -y
148+
sudo apt update
149+
sudo apt install make gcc ripgrep unzip git xclip neovim
150+
188151
</details>
189152

190-
#### Linux Install
153+
### Linux Install
154+
191155
<details><summary>Ubuntu Install Steps</summary>
192156

193-
```
194-
sudo add-apt-repository ppa:neovim-ppa/unstable -y
195-
sudo apt update
196-
sudo apt install make gcc ripgrep unzip git xclip neovim
197-
```
157+
sudo add-apt-repository ppa:neovim-ppa/unstable -y
158+
sudo apt update
159+
sudo apt install make gcc ripgrep unzip git xclip neovim
160+
198161
</details>
199-
<details><summary>Debian Install Steps</summary>
200162

201-
```
202-
sudo apt update
203-
sudo apt install make gcc ripgrep unzip git xclip curl
163+
<details><summary>Debian Install Steps</summary>
204164

205-
# Now we install nvim
206-
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
207-
sudo rm -rf /opt/nvim-linux64
208-
sudo mkdir -p /opt/nvim-linux64
209-
sudo chmod a+rX /opt/nvim-linux64
210-
sudo tar -C /opt -xzf nvim-linux64.tar.gz
165+
sudo apt update
166+
sudo apt install make gcc ripgrep unzip git xclip curl
167+
168+
# Now we install nvim
169+
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
170+
sudo rm -rf /opt/nvim-linux64
171+
sudo mkdir -p /opt/nvim-linux64
172+
sudo chmod a+rX /opt/nvim-linux64
173+
sudo tar -C /opt -xzf nvim-linux64.tar.gz
174+
175+
# make it available in /usr/local/bin, distro installs to /usr/bin
176+
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
211177

212-
# make it available in /usr/local/bin, distro installs to /usr/bin
213-
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
214-
```
215178
</details>
179+
216180
<details><summary>Fedora Install Steps</summary>
217181

218-
```
219-
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
220-
```
182+
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
183+
221184
</details>
222185

223186
<details><summary>Arch Install Steps</summary>
224187

225-
```
226-
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
227-
```
228-
</details>
188+
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
229189

190+
</details>

0 commit comments

Comments
 (0)