Skip to content

Commit 604b0a5

Browse files
update nvim with upstream
2 parents 21f2ee7 + 6ba2408 commit 604b0a5

File tree

8 files changed

+387
-201
lines changed

8 files changed

+387
-201
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ assignees: ''
99

1010
<!-- Any bug report not following this template will be immediately closed. Thanks -->
1111

12+
## Before Reporting an Issue
13+
- I have read the kickstart.nvim README.md.
14+
- I have read the appropriate plugin's documentation.
15+
- I have searched that this issue has not been reported before.
16+
17+
- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
18+
1219
## Describe the bug
1320
<!-- A clear and concise description of what the bug is. -->
1421

@@ -18,8 +25,8 @@ assignees: ''
1825

1926
## Desktop
2027
<!-- please complete the following information. -->
21-
- OS:
22-
- Terminal:
28+
- OS:
29+
- Terminal:
2330

2431
## Neovim Version
2532
<!-- Output of running `:version` from inside of neovim. -->

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,68 @@
99

1010
> Install requires Neovim 0.9+. Always review the code before installing a configuration.
1111
12-
Clone the repository and install the plugins:
12+
## Installation
13+
14+
### Install Neovim
15+
16+
Kickstart.nvim targets *only* the latest
17+
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
18+
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
19+
If you are experiencing issues, please make sure you have the latest versions.
20+
21+
### Install External Dependencies
22+
23+
External Requirements:
24+
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
25+
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
26+
[fd-find](https://github.com/sharkdp/fd#installation)
27+
- Clipboard tool (xclip/xsel/win32yank or other depending on the 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
30+
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
31+
- Language Setup:
32+
- If you want to write Typescript, you need `npm`
33+
- If you want to write Golang, you will need `go`
34+
- etc.
35+
36+
> [!NOTE]
37+
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
38+
> and quick install snippets
39+
40+
### Install Kickstart
41+
42+
> [!NOTE]
43+
> [Backup](#FAQ) your previous configuration (if any exists)
44+
45+
Neovim's configurations are located under the following paths, depending on your OS:
46+
47+
| OS | PATH |
48+
| :- | :--- |
49+
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
50+
| Windows (cmd)| `%localappdata%\nvim\` |
51+
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
52+
53+
#### Recommended Step
54+
55+
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
56+
so that you have your own copy that you can modify, then install by cloning the
57+
fork to your machine using one of the commands below, depending on your OS.
58+
59+
> [!NOTE]
60+
> Your fork's URL will be something like this:
61+
> `https://github.com/<your_github_username>/kickstart.nvim.git`
62+
63+
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
64+
too - it's ignored in the kickstart repo to make maintenance easier, but it's
65+
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
66+
67+
#### Clone kickstart.nvim
68+
69+
> [!NOTE]
70+
> If following the recommended step above (i.e., forking the repo), replace
71+
> `nvim-lua` with `<your_github_username>` in the commands below
72+
73+
<details><summary> Linux and Mac </summary>
1374

1475
```sh
1576
git clone [email protected]:juanmiguelRuaDev/kickstart.nvim ~/.config/juanmiguelRuaDev/kickstart.nvim
@@ -102,5 +163,8 @@ NVIM_APPNAME=juanmiguelRuaDev/kickstart.nvim/ nvim
102163
+ html
103164
+ tflint
104165

166+
> [!NOTE]
167+
> For more information about a particular plugin check its repository's documentation.
168+
105169

106170
This readme was generated by [Dotfyle](https://dotfyle.com)

0 commit comments

Comments
 (0)