You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: Installation and Contribution is right at the top of this page
53
+
41
54
---
42
55
43
-
## ✨ Introduction
56
+
## Introduction
44
57
45
-
Welcome to **nvimDev** – a sleek, fast, and highly customizable Neovim distribution built by me,
58
+
Welcome to **nvimDev** – a sleek, fast, and highly customizable Neovim distribution started by
46
59
</br>
47
60
**Priyanshu Ranjan**, final-year student at **IIT Kharagpur**. 🌟
48
61
49
62
This project started as a quest for the **perfect code editor**. While many Neovim distros exist, none had the **set of plugins or keybindings** I wanted(ofc this is not possible), nor did they offer a code structure that was simple to configure and understand. So, I decided to build one myself! 🚀
50
63
51
-
### Why **nvimDev**?
64
+
---
65
+
66
+
## Why **nvimDev**?
52
67
53
68
Most Neovim distros are either **too bloated** or **hard to customize**. The code structure is often complex, making it difficult for users to add their own configurations. That’s where **nvimDev** shines – it’s built to be:
54
69
@@ -64,133 +79,23 @@ Stay tuned for frequent updates as this project is still under development. 🌱
64
79
65
80
---
66
81
67
-
## ⚡ Requirements
82
+
## Requirements
68
83
69
-
What you need to have?
84
+
To get started with nvimDev, you’ll need the following:
70
85
71
-
-OS - Linux/MacOS/WSL
72
-
-[Neovim 0.10.0+, built with LuaJIT](https://github.com/neovim/neovim/releases/tag/stable)
73
-
-A [Nerd Font](https://www.nerdfonts.com/font-downloads) (Optional)
74
-
-A terminal with true color support (Optional)
86
+
-**Operating System**: Linux/MacOS/WSL (Windows support coming soon)
87
+
-**[Neovim](https://github.com/neovim/neovim/releases/tag/stable)**: Version 0.10.0+ (built with LuaJIT)
88
+
-**[Nerd Font](https://www.nerdfonts.com/font-downloads)**: Optional for enhanced UI
89
+
-**Terminal**: One with true color support (optional for better aesthetics)
75
90
76
91
---
77
92
78
-
## 🛠️ Installation
79
-
80
-
### Backup your Existing Configuration
81
-
82
-
At first, backup your existing neovim configuration
83
-
</br>
84
-
Follow the below commands to backup:
85
-
86
-
```sh
87
-
mv ~/.config/nvim{,.bak}
88
-
89
-
# optional but recommended
90
-
mv ~/.local/share/nvim{,.bak}
91
-
mv ~/.local/state/nvim{,.bak}
92
-
mv ~/.cache/nvim{,.bak}
93
-
```
94
-
95
-
</br>
96
-
If you don't have one or don't care about it, just forget it
97
-
</br>
98
-
</br>
99
-
Mastering manual processes is essential for any programmer!
100
-
</br>
101
-
So, let's take the time to clone the repository manually(it's easy)
102
-
103
-
### Clone (Linux/MacOS/WSL)
104
-
105
-
- Follow one of the following commands. Either one is fine.
106
-
107
-
```sh
108
-
# Directly clone the repository to the ~/.config/nvim folder
# Replace the ~/path/to/nvimDev with your own path
119
-
ln -s ~/path/to/nvimDev ~/.config/nvim
120
-
```
121
-
122
-
- Now delete the .git folder to enable adding this to your own repository later
123
-
124
-
```sh
125
-
rm -rf ~/.config/nvim/.git
126
-
```
93
+
## Getting Started
127
94
128
-
### Downloading from Releases
129
-
130
-
Like a specific release? Download from previous releases
131
-
132
-
- Go to the releases part in the about section
133
-
- Click on the specific release
134
-
- Download the the source code
135
-
- Move the contents of the folder to the nvim repo on your machine
136
-
137
-
### Getting Started
138
-
139
-
Wanna start 'nviming'? Enter the below command
140
-
141
-
```sh
142
-
nvim .
143
-
```
144
-
145
-
You are good to go now! 😎
146
-
</br>
147
-
Enjoy Coding
148
-
149
-
---
150
-
151
-
## 🤝 Contribution
152
-
153
-
Whether you're fixing bugs, improving the configuration, adding new features or just want to update Readme!
154
-
</br>
155
-
Want to document the Distro? Add about Configuration, Keybindings, Commands and Plugins to the Wiki Section.
156
-
</br>
157
-
</br>
158
-
I’m eager to collaborate with anyone passionate about improving nvimDev.
159
-
</br>
160
-
If you have ideas or suggestions, feel free to open an issue or submit a pull request.
161
-
</br>
162
-
163
-
### How to Contribute:
164
-
165
-
1. Fork the repository.
166
-
167
-
2. Create a new branch
168
-
169
-
```sh
170
-
# replace feature-name with your feature
171
-
git checkout -b feature-name
172
-
```
173
-
174
-
4. Make your changes and commit
175
-
176
-
```sh
177
-
# write a meaningful commit message concluding your feature
178
-
git commit -m "Added some feature"
179
-
```
180
-
181
-
6. Push to the branch
182
-
183
-
```sh
184
-
git push origin feature-name
185
-
```
186
-
187
-
8. Open a pull request
188
-
189
-
</br>
190
-
Feel free to reach out if you have any questions! Let's make this project better together.
95
+
If you're new to Neovim or looking for guidance, we highly recommend visiting the [Wiki Section](https://github.com/prrockzed/nvimDev/wiki)(Currently in Development Phase) for documentation. Beginners can find in-depth tutorials to help them get up and running, while advanced users will discover insights and tips to get the most out of nvimDev.
191
96
192
97
---
193
98
194
-
## ⭐ Acknowledgements
99
+
## Acknowledgements
195
100
196
101
Thanks to [Neovim](https://github.com/neovim/neovim) for enabling the creation of a powerful and customizable terminal-based code editor
Make sure to check the [Requirements](https://github.com/noobdumbledore/nvimDev/blob/main/.github/README.md#requirements) before proceeding. This ensures your system is properly set up for a smooth installation experience.
6
+
7
+
Once you've met the necessary requirements, installing **nvimDev** is straightforward.
8
+
</br>
9
+
</br>
10
+
If you are a very beginner and don't want to through the hassle, just follow the simple steps given below:
11
+
12
+
1. Run the commands given in: **[Backup your Existing Configuration](#backup-your-existing-configuration)**
13
+
2. Run the 1st command given in: **[Clone Section](#clone-linuxmacoswsl)** (depending on your Operating System)
14
+
3. Run the command in **[Getting Started](#getting-started)**
15
+
16
+
</br>
17
+
18
+
## Backup your Existing Configuration
19
+
20
+
At first, backup your existing neovim configuration
21
+
</br>
22
+
Follow the below commands to backup:
23
+
24
+
```sh
25
+
mv ~/.config/nvim{,.bak}
26
+
27
+
# optional but recommended
28
+
mv ~/.local/share/nvim{,.bak}
29
+
mv ~/.local/state/nvim{,.bak}
30
+
mv ~/.cache/nvim{,.bak}
31
+
```
32
+
33
+
</br>
34
+
If you don't have one or don't care about it, just forget it
35
+
</br>
36
+
</br>
37
+
Mastering manual processes is essential for any programmer!
38
+
</br>
39
+
So, let's take the time to clone the repository manually(it's easy)
40
+
41
+
## Clone (Linux/MacOS/WSL)
42
+
43
+
- Follow one of the following commands. Either one is fine.
44
+
45
+
```sh
46
+
# Directly clone the repository to the ~/.config/nvim folder
0 commit comments