Skip to content

qvacua/vimr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

09cd351 · May 27, 2024
May 27, 2024
Apr 26, 2024
Apr 26, 2024
May 27, 2024
May 6, 2024
Apr 26, 2024
May 15, 2024
Apr 26, 2024
May 6, 2024
Dec 17, 2023
May 27, 2024
Jan 15, 2024
Dec 13, 2021
May 17, 2024
Dec 22, 2019
Dec 11, 2023
Nov 13, 2023
Dec 23, 2023
Dec 24, 2021
Nov 24, 2023
Jan 19, 2024
Jun 16, 2022
Nov 24, 2023
Apr 26, 2024
Apr 26, 2024

Repository files navigation

VimR — Neovim GUI for macOS

DownloadDocumentation

Screenshot 1 Screenshot 2

About

Project VimR is a Neovim GUI for macOS written in Swift.

The goal is to build an editor that uses Neovim inside with many of the convenience GUI features similar to those present in modern editors. We mainly use Swift, but also use C/Objective-C when where appropriate.

There are other Neovim GUIs for macOS, see the list, so why?

  • Play around with Neovim,
  • play around with Swift (and especially with RxSwift),
  • Play around with the main idea of Redux architecture, and
  • (most importantly) have fun!

If you feel chatty, there is a chat room: https://matrix.to/#/#vimr:matrix.org

If you want to support VimR financially, use Github's Sponsor.

Download

Pre-built Universal signed and notarized binaries can be found under Releases.

Reusable Components

  • RxMsgpackRpc: Implementation of MsgpackRpc using RxSwift.
  • RxNeovimApi: RxSwift wrapper of Neovim API.
  • NvimView: SwiftPM module containing an NSView which bundles everything, e.g., Neovim binary and its runtime-files, needed to embed Neovim in a Cocoa App.

Some Features

  • Markdown preview
  • Generic HTML preview (retains the scroll position when reloading)
  • Fuzzy file finder a la Xcode's "Open Quickly..."
  • Trackpad support: Pinching for zooming and two-finger scrolling.
  • Ligatures: Turned off by default. Turn it on in the Preferences.
  • Command line tool.
  • (Simple) File browser
  • Flexible workspace model a la JetBrain's IDEs

How to Build

Clone this repository. Install homebrew, then in the project root:

git submodule init
git submodule update

xcode-select --install # install the Xcode command line tools, if you haven't already
brew bundle

clean=true notarize=false ./bin/build_vimr.sh
# VimR.app will be placed in ./build/Build/Products/Release/

Development

See DEVELOP.md.

License

MIT