From d0b3c167a677d23cc244679b2157604f7b1f2ad8 Mon Sep 17 00:00:00 2001 From: prrockzed Date: Sun, 29 Sep 2024 14:03:37 +0530 Subject: [PATCH] Updated Readme Added Introduction --- .github/README.md | 57 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/.github/README.md b/.github/README.md index 0e3215d..9942c4a 100644 --- a/.github/README.md +++ b/.github/README.md @@ -3,10 +3,10 @@

For those ready to transform their Workflow

- Latest release + Latest release - - License + + Last commit Stars @@ -14,15 +14,23 @@ Issues +
+ + License + - Repo Size + Repo Size + +
+ + Open Source

--- -## Contents +## πŸ“‘ Contents - [Introduction](#introduction) - [Dependencies](#dependencies) @@ -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,
-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 @@ -111,9 +136,7 @@ Like a specific release? Download from previous releases ### Getting Started -Wanna start 'nviming'? -
-Enter the below command to dive into your programming repo +Wanna start 'nviming'? Enter the below command ```sh nvim . @@ -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!
+Want to document the Distro? Add about Configuration, Keybindings, Commands and Plugins to the Wiki Section.
-Whether you're fixing bugs, improving the configuration, adding new features or just want to update Readme!
I’m eager to collaborate with anyone passionate about improving nvimDev.
@@ -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