Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
Added Introduction
  • Loading branch information
prrockzed committed Sep 29, 2024
1 parent 1df80ff commit d0b3c16
Showing 1 changed file with 40 additions and 17 deletions.
57 changes: 40 additions & 17 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,34 @@
<p>For those ready to transform their Workflow</p>
<p>
<a href="https://github.com/prrockzed/nvimDev/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/prrockzed/nvimDev?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41&include_prerelease&sort=semver" />
<img alt="Latest release" src="https://img.shields.io/github/v/release/prrockzed/nvimDev?style=for-the-badge&logo=github&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41&include_prerelease&sort=semver" />
</a>
<a href="https://github.com/prrockzed/nvimDev/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/prrockzed/nvimDev?style=for-the-badge&logo=starship&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
<a href="https://github.com/prrockzed/nvimDev/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/prrockzed/nvimDev?style=for-the-badge&logo=git&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/prrockzed/nvimDev/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/prrockzed/nvimDev?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/prrockzed/nvimDev/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/prrockzed/nvimDev?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
</br>
<a href="https://github.com/prrockzed/nvimDev/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/prrockzed/nvimDev?style=for-the-badge&logo=creativecommons&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/prrockzed/nvimDev">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/prrockzed/nvimDev?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/prrockzed/nvimDev?style=for-the-badge&logo=codesandbox&color=%23DDB6F2&label=SIZE&logoColor=D9E0EE&labelColor=302D41" />
</a>
</br>
<a href="https://github.com/prrockzed/nvimDev">
<img alt="Open Source" src="https://img.shields.io/badge/Free%20and%20Open%20Source-brightgreen?style=for-the-badge" />
</a>
</p>
</div>

---

## Contents
## 📑 Contents

- [Introduction](#introduction)
- [Dependencies](#dependencies)
Expand All @@ -32,25 +40,42 @@

---

## Introduction
## Introduction

Currently in Development Phase. Keep Patience!!
Welcome to **nvimDev** – a sleek, fast, and highly customizable Neovim distribution built by me,
</br>
Trying to make development(and Neovim in particular 😅) simple.
**Priyanshu Ranjan**, final-year student at **IIT Kharagpur**. 🌟

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! 🚀

### Why **nvimDev**?

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:

- 🔥 **Lightweight** – Takes minimal space and RAM.
-**Fast** – With lazy loading, your experience remains **buttery smooth**, no matter how many plugins you use.
- 🎨 **Aesthetic** – Get a beautiful UI experience right out of the box.
- 🖱️ **User-Friendly** – Simplified keybindings that make navigation feel like second nature.
- 🛠️ **Easy to Customize** – The code structure is neat, with separate folders for plugin configurations and core settings. Make it **your own** with just a few tweaks!

Whether you’re an **experienced Neovim user** or just a **beginner** looking for a powerful code editor, **nvimDev** is made for you! The learning curve is smooth and once you get the hang of it, it’ll feel like home. 🏡

Stay tuned for frequent updates as this project is still under development. 🌱 And yes, it’s **free and open-source**, written in Lua, and runs smoothly on any Unix system. Fast and Easy Installation. Use it anytime anywhere.

---

## Dependencies
## ⚡ Requirements

What you need to have?

- OS - Linux/MacOS/WSL
- [Neovim 0.10.0+, built with LuaJIT](https://github.com/neovim/neovim/releases/tag/stable)
- A [Nerd Font](https://www.nerdfonts.com/font-downloads) (Optional)
- A terminal with true color support (Optional)

---

## Installation
## 🛠️ Installation

### Backup your Existing Configuration

Expand Down Expand Up @@ -111,9 +136,7 @@ Like a specific release? Download from previous releases

### Getting Started

Wanna start 'nviming'?
</br>
Enter the below command to dive into your programming repo
Wanna start 'nviming'? Enter the below command

```sh
nvim .
Expand All @@ -125,12 +148,12 @@ Enjoy Coding

---

## Contribution
## 🤝 Contribution

Contributions are welcome!
Whether you're fixing bugs, improving the configuration, adding new features or just want to update Readme!
</br>
Want to document the Distro? Add about Configuration, Keybindings, Commands and Plugins to the Wiki Section.
</br>
Whether you're fixing bugs, improving the configuration, adding new features or just want to update Readme!
</br>
I’m eager to collaborate with anyone passionate about improving nvimDev.
</br>
Expand Down Expand Up @@ -168,6 +191,6 @@ Feel free to reach out if you have any questions! Let's make this project better

---

## Acknowledgements
## Acknowledgements

Thanks to [Neovim](https://github.com/neovim/neovim) for enabling the creation of a powerful and customizable terminal-based code editor

0 comments on commit d0b3c16

Please sign in to comment.