Skip to content

Commit b27f29f

Browse files
committed
Adjusting README to a personal config
1 parent 3338d39 commit b27f29f

File tree

4 files changed

+67
-185
lines changed

4 files changed

+67
-185
lines changed

README.md

Lines changed: 9 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,12 @@
1-
# kickstart.nvim
1+
# n-ide.nvim
22

3-
## Introduction
4-
5-
A starting point for Neovim that is:
6-
7-
* Small
8-
* Single-file
9-
* Completely Documented
10-
11-
**NOT** a Neovim distribution, but instead a starting point for your configuration.
3+
Thats my config for nvim to use as a IDE, its forked from kickstart.nvim, suit yourself to use as you like, but I strongly recommend you to use kickstart.nvim repository to build your own config, its very easy to start and understand.
124

135
## Installation
146

157
### Install Neovim
168

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.
20-
If you are experiencing issues, please make sure you have the latest versions.
9+
This was build to use in a arch distro, I dont have any intention to port this to another OS, if you have a different enviroment, again I highly recommend you to see the kickstart.nvim repositoty, they have support for Window, maybe Mac and other Linux distros. (Probably this will work in any popular modern distro, just check the requirements below)
2110

2211
### Install External Dependencies
2312

@@ -26,75 +15,28 @@ External Requirements:
2615
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
2716
[fd-find](https://github.com/sharkdp/fd#installation)
2817
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
29-
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
30-
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
31-
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
18+
- A [Nerd Font](https://www.nerdfonts.com/): optional, this can be turned off easily
3219
- Language Setup:
3320
- If you want to write Typescript, you need `npm`
3421
- If you want to write Golang, you will need `go`
3522
- etc.
3623

37-
> [!NOTE]
38-
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
39-
> and quick install snippets
24+
#### Arch Requeriments
25+
26+
```
27+
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
28+
```
4029

4130
### Install Kickstart
4231

4332
> [!NOTE]
4433
> [Backup](#FAQ) your previous configuration (if any exists)
4534
46-
Neovim's configurations are located under the following paths, depending on your OS:
47-
48-
| OS | PATH |
49-
| :- | :--- |
50-
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
51-
| Windows (cmd)| `%localappdata%\nvim\` |
52-
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
53-
54-
#### Recommended Step
55-
56-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
57-
so that you have your own copy that you can modify, then install by cloning the
58-
fork to your machine using one of the commands below, depending on your OS.
59-
60-
> [!NOTE]
61-
> Your fork's URL will be something like this:
62-
> `https://github.com/<your_github_username>/kickstart.nvim.git`
63-
64-
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
65-
too - it's ignored in the kickstart repo to make maintenance easier, but it's
66-
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
67-
6835
#### Clone kickstart.nvim
6936

70-
> [!NOTE]
71-
> If following the recommended step above (i.e., forking the repo), replace
72-
> `nvim-lua` with `<your_github_username>` in the commands below
73-
74-
<details><summary> Linux and Mac </summary>
75-
7637
```sh
7738
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
7839
```
79-
80-
</details>
81-
82-
<details><summary> Windows </summary>
83-
84-
If you're using `cmd.exe`:
85-
86-
```
87-
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
88-
```
89-
90-
If you're using `powershell.exe`
91-
92-
```
93-
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
94-
```
95-
96-
</details>
97-
9840
### Post Installation
9941

10042
Start Neovim
@@ -106,20 +48,6 @@ nvim
10648
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
10749
the current plugin status. Hit `q` to close the window.
10850

109-
#### Read The Friendly Documentation
110-
111-
Read through the `init.lua` file in your configuration folder for more
112-
information about extending and exploring Neovim. That also includes
113-
examples of adding popularly requested plugins.
114-
115-
> [!NOTE]
116-
> For more information about a particular plugin check its repository's documentation.
117-
118-
119-
### Getting Started
120-
121-
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
122-
12351
### FAQ
12452

12553
* What should I do if I already have a pre-existing Neovim configuration?
@@ -139,103 +67,3 @@ examples of adding popularly requested plugins.
13967
distribution that you would like to try out.
14068
* What if I want to "uninstall" this configuration:
14169
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
142-
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
143-
* The main purpose of kickstart is to serve as a teaching tool and a reference
144-
configuration that someone can easily use to `git clone` as a basis for their own.
145-
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
146-
into smaller parts. A fork of kickstart that does this while maintaining the
147-
same functionality is available here:
148-
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
149-
* Discussions on this topic can be found here:
150-
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
151-
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
152-
153-
### Install Recipes
154-
155-
Below you can find OS specific install instructions for Neovim and dependencies.
156-
157-
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
158-
159-
#### Windows Installation
160-
161-
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
162-
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
163-
164-
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
165-
166-
This requires:
167-
168-
- Install CMake and the Microsoft C++ Build Tools on Windows
169-
170-
```lua
171-
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
172-
```
173-
</details>
174-
<details><summary>Windows with gcc/make using chocolatey</summary>
175-
Alternatively, one can install gcc and make which don't require changing the config,
176-
the easiest way is to use choco:
177-
178-
1. install [chocolatey](https://chocolatey.org/install)
179-
either follow the instructions on the page or use winget,
180-
run in cmd as **admin**:
181-
```
182-
winget install --accept-source-agreements chocolatey.chocolatey
183-
```
184-
185-
2. install all requirements using choco, exit the previous cmd and
186-
open a new one so that choco path is set, and run in cmd as **admin**:
187-
```
188-
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
189-
```
190-
</details>
191-
<details><summary>WSL (Windows Subsystem for Linux)</summary>
192-
193-
```
194-
wsl --install
195-
wsl
196-
sudo add-apt-repository ppa:neovim-ppa/unstable -y
197-
sudo apt update
198-
sudo apt install make gcc ripgrep unzip git xclip neovim
199-
```
200-
</details>
201-
202-
#### Linux Install
203-
<details><summary>Ubuntu Install Steps</summary>
204-
205-
```
206-
sudo add-apt-repository ppa:neovim-ppa/unstable -y
207-
sudo apt update
208-
sudo apt install make gcc ripgrep unzip git xclip neovim
209-
```
210-
</details>
211-
<details><summary>Debian Install Steps</summary>
212-
213-
```
214-
sudo apt update
215-
sudo apt install make gcc ripgrep unzip git xclip curl
216-
217-
# Now we install nvim
218-
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
219-
sudo rm -rf /opt/nvim-linux-x86_64
220-
sudo mkdir -p /opt/nvim-linux-x86_64
221-
sudo chmod a+rX /opt/nvim-linux-x86_64
222-
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
223-
224-
# make it available in /usr/local/bin, distro installs to /usr/bin
225-
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
226-
```
227-
</details>
228-
<details><summary>Fedora Install Steps</summary>
229-
230-
```
231-
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
232-
```
233-
</details>
234-
235-
<details><summary>Arch Install Steps</summary>
236-
237-
```
238-
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
239-
```
240-
</details>
241-

init.lua

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ vim.g.mapleader = ' '
9191
vim.g.maplocalleader = ' '
9292

9393
-- Set to true if you have a Nerd Font installed and selected in the terminal
94-
vim.g.have_nerd_font = false
94+
vim.g.have_nerd_font = true
9595

9696
-- [[ Setting options ]]
9797
-- See `:help vim.o`
@@ -894,7 +894,7 @@ require('lazy').setup({
894894
-- Load the colorscheme here.
895895
-- Like many other themes, this one has different styles, and you could load
896896
-- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'.
897-
vim.cmd.colorscheme 'tokyonight-night'
897+
vim.cmd.colorscheme 'rose-pine-moon'
898898
end,
899899
},
900900

@@ -984,7 +984,7 @@ require('lazy').setup({
984984
-- This is the easiest way to modularize your config.
985985
--
986986
-- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going.
987-
-- { import = 'custom.plugins' },
987+
{ import = 'custom.plugins' },
988988
--
989989
-- For additional information with loading, sourcing and examples see `:help lazy.nvim-🔌-plugin-spec`
990990
-- Or use telescope!

lazy-lock.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"LuaSnip": { "branch": "master", "commit": "458560534a73f7f8d7a11a146c801db00b081df0" },
3+
"blink.cmp": { "branch": "main", "commit": "586ee87534f5bf65f1c8dea2d1da2a57e8cddd36" },
4+
"conform.nvim": { "branch": "master", "commit": "973f3cb73887d510321653044791d7937c7ec0fa" },
5+
"fidget.nvim": { "branch": "main", "commit": "d9ba6b7bfe29b3119a610892af67602641da778e" },
6+
"gitsigns.nvim": { "branch": "main", "commit": "0cb5a7753d3c4b8e9cfdc9d88d9110cb8d4b1544" },
7+
"guess-indent.nvim": { "branch": "main", "commit": "84a4987ff36798c2fc1169cbaff67960aed9776f" },
8+
"lazy.nvim": { "branch": "main", "commit": "6c3bda4aca61a13a9c63f1c1d1b16b9d3be90d7a" },
9+
"lazydev.nvim": { "branch": "main", "commit": "2367a6c0a01eb9edb0464731cc0fb61ed9ab9d2c" },
10+
"mason-lspconfig.nvim": { "branch": "main", "commit": "a9c876d72d82b6640266f8b248ac05a63630b1d9" },
11+
"mason-tool-installer.nvim": { "branch": "main", "commit": "517ef5994ef9d6b738322664d5fdd948f0fdeb46" },
12+
"mason.nvim": { "branch": "main", "commit": "8024d64e1330b86044fed4c8494ef3dcd483a67c" },
13+
"mini.nvim": { "branch": "main", "commit": "7504a87ca0500bdf71f89ffacd77851d71378635" },
14+
"nvim-lspconfig": { "branch": "master", "commit": "dbfd8da6206b4ab0e2fe9b72a538f82e2b410102" },
15+
"nvim-treesitter": { "branch": "master", "commit": "42fc28ba918343ebfd5565147a42a26580579482" },
16+
"nvim-web-devicons": { "branch": "master", "commit": "0422a19d9aa3aad2c7e5cca167e5407b13407a9d" },
17+
"plenary.nvim": { "branch": "master", "commit": "857c5ac632080dba10aae49dba902ce3abf91b35" },
18+
"rose-pine": { "branch": "main", "commit": "f93360149e9ed4df8677fbb07c7231ea0fd03b97" },
19+
"telescope-fzf-native.nvim": { "branch": "main", "commit": "1f08ed60cafc8f6168b72b80be2b2ea149813e55" },
20+
"telescope-ui-select.nvim": { "branch": "master", "commit": "6e51d7da30bd139a6950adf2a47fda6df9fa06d2" },
21+
"telescope.nvim": { "branch": "master", "commit": "b4da76be54691e854d3e0e02c36b0245f945c2c7" },
22+
"todo-comments.nvim": { "branch": "main", "commit": "304a8d204ee787d2544d8bc23cd38d2f929e7cc5" },
23+
"toggleterm.nvim": { "branch": "main", "commit": "50ea089fc548917cc3cc16b46a8211833b9e3c7c" },
24+
"tokyonight.nvim": { "branch": "main", "commit": "057ef5d260c1931f1dffd0f052c685dcd14100a3" },
25+
"which-key.nvim": { "branch": "main", "commit": "370ec46f710e058c9c1646273e6b225acf47cbed" }
26+
}

lua/custom/plugins/init.lua

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,32 @@
22
-- I promise not to create any merge conflicts in this directory :)
33
--
44
-- See the kickstart.nvim README for more information
5-
return {}
5+
return {
6+
{
7+
'rose-pine/neovim',
8+
name = 'rose-pine',
9+
},
10+
{
11+
'akinsho/toggleterm.nvim',
12+
version = '*',
13+
opts = {
14+
direction = 'float',
15+
open_mapping = [[<leader>ç]],
16+
float_opts = {
17+
border = 'curved',
18+
highlights = {
19+
border = 'Normal',
20+
background = 'Normal',
21+
},
22+
},
23+
start_in_insert = true,
24+
autochdir = true,
25+
insert_mappings = true,
26+
terminal_mappings = true,
27+
shade_terminals = false,
28+
persist_size = true,
29+
close_on_exit = true,
30+
shell = vim.o.shell,
31+
},
32+
},
33+
}

0 commit comments

Comments
 (0)