gonvim

README

Gonvim

Gonvim is a Neovim GUI written in Golang, using a Golang qt backend.

This repository forked from the original Gonvim for the purpose of maintenance and enhancement.

Table of contents

• Getting started
• Configurations
• Features
• Development
• Contributing
• Simmilar Projects
• License
• Credits

Getting Started

Pre-built packages for Windows, MacOS, and Linux are found at the Releases page.

Prerequisites

MacOS or Linux users need to install neovim. See Installing Neovim

MacOS

gonvim.app looks for the nvim process from the following.

/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/local/bin:/opt/local/sbin

Deployment example:

cd /path/to
curl -LO https://github.com/neovim/neovim/releases/download/nightly/nvim-macos.tar.gz
tar xf nvim-macos.tar.gz
ln -s /path/to/bin/nvim /usr/local/bin/nvim

Linux

Deploy Neovim under the $PATH.

Windows

Add Gonvim bin path to %PATH% environment variable.

Configurations

application	config file
Gonvim (GUI front end of neovim)	~/.gonvim/setting.toml
Neovim	$XDG_CONFIG_HOME/nvim/init.vim

where the default value of $XDG_CONFIG_HOME is the below.

OS	$XDG_CONFIG_HOME
Unix	~/.config
Windows	~/AppData/Local

For details of ~/.gonvim/setting.toml, See wiki

Features

• Fuzzy Finder
• Markdown Preview
• MiniMap
• Dein.vim GUI

Development

• Development

Contributing

Gonvim welcomes contribution. If you want to add your changes to the Gonvim, Please following steps

1. Fork this repository
2. Create a branch for your contribution
3. Add contributions to the branch
4. Create a pull request against the master branch of the Gonvim repository.

Simmilar projects

• Oni
• Veonim

License

Gonvim is released under MIT license

Credits

• Gonvim was created by dzhou121 (https://github.com/dzhou121/gonvim)
• Gonvim application icon was made using gopher-vector made by Takuya Ueda (https://twitter.com/tenntenn). The original gopher was designed by Renee French http://reneefrench.blogspot.com/.