Style README.md

This commit is contained in:
2025-01-24 02:00:15 +03:00
parent eeaabc1b1a
commit 2a1f010a7f

View File

@@ -1,24 +1,33 @@
# 🖼️ PicVim
> ⚠️ **Note:** This project is still early in development, so it may be a bit buggy. If you find any bugs, please let me know!
---
PicVim is a Neovim plugin that allows you to view and interact with images directly in Neovim. It supports various image formats such as PNG, JPG, GIF, BMP, and more, offering basic functionality like zooming, rotating, and panning.
- It is meant as a quick way to view and interact with images in Neovim.
- It is not intended as a replacement to image.nvim (Can't render images in README.md).
- It provides a powerful way to interact with viewing images allowing for zooming, panning etc.
### Key Features:
- 🚀 **Quick Image Viewing:** View images directly in Neovim.
- 🔄 **Basic Image Interaction:** Zoom, rotate, and pan.
- 🌐 **Multi-format Support:** Works with PNG, JPG, GIF, BMP, and more.
### ⚠️ Important Notes:
- 🚫 **Not a replacement for `image.nvim`:** This plugin can't render images in `README.md` files.
- 🔧 **Early Development:** This is a work in progress, so expect some bugs. Contributions are welcome!
---
## Demo
https://github.com/user-attachments/assets/b8279faa-4e91-4fda-880b-4d4d7cab117d
## Usage
## 📖 Usage
To use PicVim, simply open an image file in Neovim and the image will be displayed in the buffer. You can interact with the image using the provided keybindings.
## Features
## Features
- View images in Neovim.
- Zoom in and out using keybindings.
@@ -27,7 +36,7 @@ To use PicVim, simply open an image file in Neovim and the image will be display
- Automatically scale and adjust images for optimal viewing.
- For now it only supports Kitty Graphics Protocol, but will soon support ueberzugpp too.
## Installation
## ⚙️ Installation
Use your prefferred package manager to install PicVim.
@@ -41,7 +50,7 @@ If you use [lazy.nvim](https://github.com/folke/lazy.nvim), you can install PicV
}
```
## Setup
## 🔧 Setup
To activate the plugin, add the following to your init.lua configuration file (not needed if using lazy.nvim):
@@ -49,11 +58,11 @@ To activate the plugin, add the following to your init.lua configuration file (n
require'picvim'.setup()
```
## Auto-commands
## 🛠️ Auto-commands
The plugin automatically activates for image files (.png, .jpg, .jpeg, .gif, .bmp) upon opening. It sets the buffer to a "non-file" type to display the image correctly.
## Keybindings
## ⌨️ Keybindings
h, Left Arrow Pan left.
l, Right Arrow Pan right.
@@ -66,16 +75,11 @@ The plugin automatically activates for image files (.png, .jpg, .jpeg, .gif, .bm
o Reset image position and rotation.
r Redraw the image.
## Dependencies
## 📦 Dependencies
`ImageMagick` for image manipulation.
`Neovim` 0.5.0 or higher.
## Troubleshooting
Ensure you have `ImageMagick` installed for image scaling and conversion functionality.
If the image fails to load, check that the file path is correct.
## License
## 📄 License
This project is licensed under the MIT License see the LICENSE file for details.