Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 54 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,125 +3,55 @@
> The purr-fect Neovim configuration for a cozy coding session. May or may not increase your productivity by a feline factor.

<div align="center">

![Neovim](https://img.shields.io/badge/neovim-%23019733.svg?style=for-the-badge&logo=neovim&logoColor=white)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/retran/meowvim?style=for-the-badge)
![GitHub forks](https://img.shields.io/github/forks/retran/meowvim?style=for-the-badge)

<img src="assets/icon_small.png" alt="Meowvim Logo" width="160">
<br><br>
<strong>Meowvim - Purr-fect Neovim</strong>
<br><br>

![Neovim](https://img.shields.io/badge/neovim-%23019733.svg?style=for-the-badge&logo=neovim&logoColor=white)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/retran/meowvim?style=for-the-badge)
![GitHub forks](https://img.shields.io/github/forks/retran/meowvim?style=for-the-badge)
</div>

<div align="center">
<img src="assets/icon_small.png" alt="Meowvim Logo" width="200">
<br>
<strong>Meowvim - Purr-fect Neovim</strong>
</div>

A carefully crafted Neovim configuration that provides a modern development environment. Part of the `project meow`, `Meowvim` includes curated plugins, intelligent defaults, and a consistent user experience.

## 🖼️ Screenshots

<div align="center">

### Dashboard
<img src="assets/screenshot_dashboard.png" alt="Meowvim Dashboard" width="800">

### Editor
<img src="assets/screenshot_editor.png" alt="Meowvim Editor" width="800">

</div>

## 🌟 Key Features

- **🚀 Zero Configuration**: Works out of the box with sensible defaults
- **🎨 Modern Interface**: Tokyo Night theme with clean UI components
- **🧠 AI-Powered**: GitHub Copilot integration for coding assistance
- **⚡ Performance**: Optimized with lazy loading
- **🔧 Customizable**: Easy to extend and modify
- **🌐 Language Support**: Works with major programming languages
- **📦 Plugin Collection**: 25+ curated plugins for development

## 📋 Table of Contents

- [✨ Features](#-features)
- [📋 Prerequisites](#-prerequisites)
- [🚀 Installation](#-installation)
- [⚡ Quick Start](#-quick-start)
- [⚙️ Configuration](#️-configuration)
- [🔧 Troubleshooting](#-troubleshooting)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
- [🙏 Acknowledgments](#-acknowledgments)

## ✨ Features

`Meowvim` includes these development features:

### 🧠 Intelligence & Completion

- **LSP Support**: Language Server Protocol integration with automatic setup
- **GitHub Copilot**: AI-powered code completion and suggestions
- **Completion Engine**: Context-aware autocompletion with nvim-cmp
- **Code Snippets**: Snippet collection with LuaSnip
- **Syntax Highlighting**: Syntax highlighting with Treesitter

### 🎨 Interface

- **Tokyo Night Theme**: Modern, readable colorscheme
- **Status Line**: Informative status bar with Git integration
- **Buffer Management**: Buffer navigation and organization
- **Icons**: Consistent iconography throughout
- **Indent Guides**: Visual indentation helpers
---

### 🔧 Development Tools
A carefully curated Neovim configuration that delivers a modern and delightful developer experience. Part of the [Project Meow](https://github.com/retran/meow), `Meowvim` includes elegant defaults, essential plugins, and playful polish.

- **Git Integration**: Git workflow with Gitsigns and Fugitive
- **Code Formatting**: Automatic formatting with Conform.nvim
- **Linting**: Real-time code linting with nvim-lint
- **Debugging**: Debugging support with nvim-dap
- **Testing**: Test runner integration with Neotest
- **Refactoring**: Code refactoring tools
---

### 🚀 Productivity

- **Fuzzy Finder**: File and text search with Snacks
- **Auto-save**: Automatic file saving
- **Session Management**: Session persistence
- **Quick Navigation**: Leap motion for cursor movement
- **Comment Handling**: Smart comment toggling
- **Auto-pairs**: Automatic bracket and quote pairing

### 🎯 Language Support

- **Go**: Go development support with testing
- **TypeScript/JavaScript**: JS/TS development
- **Python**: Python development support
- **Lua**: Lua development for Neovim
- **Additional languages**: Extensible language support
## 🖼️ Screenshots

## 📋 Prerequisites
<div align="center">

Before installing `Meowvim`, ensure you have the following:
### Dashboard
<img src="assets/screenshot_dashboard.png" alt="Dashboard Screenshot" width="800">

### Required
### Editor
<img src="assets/screenshot_editor.png" alt="Editor Screenshot" width="800">

- **Neovim** ≥ 0.9.0
- **Git** (for plugin management)
- **A terminal** with true color support
</div>

### Recommended
---

- **Node.js** ≥ 18.0 (for some LSP servers and Copilot)
- **Python** ≥ 3.8 (for Python LSP and some plugins)
- **Go** ≥ 1.19 (for Go development)
- **Ripgrep** (for faster searching)
- **fd** (for faster file finding)
- **fzf** (for fuzzy finding)
- **JetBrains Mono Nerd Font** (for proper icon display)
## 🌟 Key Features

### Optional
- 🚀 **Zero Configuration** – Sensible defaults out of the box
- 🎨 **Modern UI** – Clean interface powered by Tokyo Night theme
- 🧠 **AI Integration** – GitHub Copilot support for smart code suggestions
- ⚡ **Fast & Lazy** – Optimized with Lazy.nvim for performance
- 🔧 **Fully Customizable** – Easy to extend with your own tweaks
- 🌐 **Language Ready** – Preconfigured LSPs for major languages
- 📦 **25+ Curated Plugins** – For everything from Git to testing
- 🧑‍💻 **GitHub Copilot Subscription** – Optional AI enhancements

- **GitHub Copilot** subscription (for AI features)
---

## 🚀 Installation

Expand Down Expand Up @@ -173,19 +103,32 @@ On first launch, `Meowvim` will:
- Download and install all plugins
- Configure Language Server Protocol (LSP) servers automatically

### 2. Basic Navigation

- **Leader key**: `Space` (main entry point for features)
- **Open project**: `Space, f, p`

- **Open smart file finder**: `Space, Space`

### 3. Set Up GitHub Copilot (Optional)
### Optional: Set Up GitHub Copilot

```vim
:Copilot auth
```

---

## 🛠 Prerequisites

### Required
- [Neovim](https://neovim.io) ≥ 0.9.0
- Git
- Terminal with true color support

### Recommended
- Node.js ≥ 18
- Python ≥ 3.8
- Go ≥ 1.19
- [Ripgrep](https://github.com/BurntSushi/ripgrep)
- [fd](https://github.com/sharkdp/fd)
- [fzf](https://github.com/junegunn/fzf)
- [JetBrains Mono Nerd Font](https://www.nerdfonts.com/font-downloads)

---

## ⚙️ Configuration

`Meowvim` is highly customizable. Here's how to make it your own:
Expand Down Expand Up @@ -415,3 +358,6 @@ Made with ❤️ by Andrew Vasilyev and feline assistants
[Report Bug](https://github.com/retran/meow/issues) · [Request Feature](https://github.com/retran/meow/issues) · [Contribute](https://github.com/retran/meow/pulls)

</div>
ues) ・ [📬 Suggest Feature](https://github.com/retran/meowvim/issues) ・ [📥 Contribute](https://github.com/retran/meowvim/pulls)

</div>