Merge pull request 'readme file update' (#1) from readme-update into main
Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
109
README.md
109
README.md
@@ -1,3 +1,108 @@
|
||||
#Mzansi Vim
|
||||
# Mzansi Vim: The No-Fuss Neovim Kickstart 🇿🇦
|
||||
|
||||
##Get Started
|
||||
A pre-configured, performance-oriented Neovim setup designed to get you from zero to coding in minutes. Built for local developers who want a powerful IDE experience without the manual overhead of a 500-line `init.lua`.
|
||||
|
||||
## Key Features
|
||||
|
||||
* **LSP & Auto-completion:** Powered by `mason.nvim` and `nvim-cmp`, featuring out-of-the-box support for Python, Lua, Docker, SQL, and more.
|
||||
* **First-Class Flutter Support:** Deep integration via `flutter-tools.nvim` for a seamless mobile development workflow.
|
||||
* **Fast Navigation:** Includes `Harpoon` for rapid file switching and `Telescope` for fuzzy finding across your project.
|
||||
* **Modern Aesthetics:** Features the `tokyonight` color scheme with enabled transparency and `lualine` for a sleek, functional status bar.
|
||||
* **Syntax Highlighting:** Robust parsing for over 15 languages via `nvim-treesitter`.
|
||||
* **Git Integration:** Quick access to Git commands using `vim-fugitive`.
|
||||
|
||||
## ⌨️ Essential Keybindings
|
||||
|
||||
The **Leader Key** is set to `Space`.
|
||||
|
||||
### 📂 Navigation & Searching
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **File Explorer** | `<leader>cd` | Open the built-in Netrw explorer. |
|
||||
| **Find Files** | `<leader>ff` | Fuzzy find files in your project. |
|
||||
| **Live Grep** | `<leader>fg` | Search for specific text across all files. |
|
||||
| **Help Tags** | `<leader>fh` | Search through Neovim help documentation. |
|
||||
|
||||
### 🎣 Harpoon (Quick-Switching)
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **Add File** | `<leader>a` | Mark the current file in Harpoon. |
|
||||
| **Harpoon Menu** | `Ctrl + e` | View and manage your marked files. |
|
||||
| **Harpoon Find** | `<leader>fl` | Use Telescope to search your Harpoon list. |
|
||||
| **Quick Nav** | `Ctrl + h/t/n/s` | Jump instantly to Harpoon files 1, 2, 3, or 4. |
|
||||
|
||||
### 🛠️ LSP & Development
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **Hover Docs** | `K` | Display documentation for the symbol under cursor. |
|
||||
| **Go to Definition**| `gd` | Jump to the source code of a function/variable. |
|
||||
| **References** | `gr` | List all places where a symbol is used. |
|
||||
| **Rename** | `<leader>rn` | Rename all occurrences of the symbol. |
|
||||
| **Code Actions** | `<leader>ca` | Show available fixes or refactors. |
|
||||
|
||||
### Editor Essentials
|
||||
| Action | Keybinding | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **Confirm Completion**| `Enter` | Accept the current suggestion in the popup menu. |
|
||||
| **Scroll Docs** | `Ctrl + f / b` | Scroll up/down in the LSP documentation window. |
|
||||
|
||||
## 🚀 Get Started
|
||||
|
||||
### 📋 Prerequisites
|
||||
To ensure all plugins (LSP, Tree-sitter, and Telescope) function correctly, please install the following:
|
||||
|
||||
* **Neovim** (v0.10+ recommended)
|
||||
* **Git** (For cloning the repo and managing plugins)
|
||||
* **Tree-sitter & Tree-sitter-cli** (For syntax highlighting)
|
||||
* **Ripgrep** (Required for Telescope live grep)
|
||||
* **Node.js & npm** (Required for various LSP servers like `html` and `eslint`)
|
||||
* **Go** (Required for certain internal tools)
|
||||
|
||||
### 📥 Installation
|
||||
|
||||
#### 1. Prepare Configuration Directory
|
||||
Depending on whether you have an existing setup, follow the appropriate step below:
|
||||
|
||||
**For a Fresh Install:**
|
||||
If you have never configured Neovim, create the configuration folder:
|
||||
```bash
|
||||
mkdir -p ~/.config/nvim
|
||||
```
|
||||
|
||||
**For an Existing Setup:**
|
||||
If you have never configured Neovim, create the configuration folder:
|
||||
```bash
|
||||
mv ~/.config/nvim ~/.config/nvim.bak
|
||||
```
|
||||
|
||||
#### 2. Clone the Repository
|
||||
Clone the Mzansi Vim configuration into your config folder:
|
||||
|
||||
```bash
|
||||
cd ~/.config/nvim
|
||||
git clone https://git.mzansi-innovation-hub.co.za/yaso_meth/mzansi_vim.git
|
||||
```
|
||||
|
||||
#### 3. Initialize
|
||||
Simply launch Neovim:
|
||||
|
||||
```bash
|
||||
nvim
|
||||
```
|
||||
|
||||
## Additional information
|
||||
|
||||
For more details about Mzansi Vim, including usage instructions and updates, please visit the [MIH Gitea repository](https://git.mzansi-innovation-hub.co.za/yaso_meth/mzansi_vim.git).
|
||||
|
||||
### Contributing
|
||||
Contributions are welcome! If you'd like to improve the package, please fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
|
||||
|
||||
### Reporting Issues/ Feature Requests
|
||||
If you encounter any bugs or have feature requests, please log an issue on the [MIH Gitea Issues page](https://git.mzansi-innovation-hub.co.za/yaso_meth/mzansi_vim.git). Provide as much detail as possible to help us address the problem promptly.
|
||||
|
||||
### Support and Response
|
||||
We strive to respond to issues and pull requests in a timely manner. While this package is maintained voluntarily, we appreciate your patience and community involvement.
|
||||
|
||||
If you would like to support the MIH development team directly, please feel free to contribute to the [MIH Project via DonaHub](https://donahub.co.za/campaigns/mih-project)
|
||||
|
||||
Thank you for using the MIH Package Toolkit!
|
||||
|
||||
Reference in New Issue
Block a user