Skip to content
VimR — Neovim GUI for macOS
Swift C Shell Python CSS Objective-C Other
Branch: develop
Clone or download

README.md

VimR — Neovim Refined

App Icon

DownloadDocumentationhttp://vimr.org

Bountysource Chat at https://gitter.im/vimr/vimr

Screenshot 1 Screenshot 0 Screenshot 2

About

Project VimR is a (YA) Neovim GUI for macOS. 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 Objective-C when its C-nature helps.

There are other Neovim GUIs for macOS, e.g. NyaoVim, neovim-dot-app, Oni, etc., so why?

  • Play around (obviously) with Neovim,
  • play around with Swift (and especially with RxSwift), and
  • (most importantly) have fun!

Download

Pre-built binaries can be found under Releases.

Reusable Components

  • RxMessagePort: RxSwift wrapper for local and remote CFMessagePort.
  • RxMsgpackRpc: implementation of MsgpackRpc using RxSwift.
  • RxNeovimApi: RxSwift wrapper of Neovim API.
  • NvimView: Cocoa Framework which bundles everything, e.g. Neovim's runtime-files, needed to embed Neovim in a Cocoa App.

If you want to support VimR financially, you can use Bountysource. Big thanks to all who did support: We list our spendings in the wiki.

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

First after cloning the VimR source tree you need to initialize git submodules

git lfs install
git submodule update --init

First install homebrew, then in the project root:

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

code_sign=false use_carthage_cache=false ./bin/build_vimr.sh # VimR.app will be placed in build/Build/Products/Release/

If the build fails for some reason, do the following and build again:

cd NvimView/neovim
git reset --hard @
git clean -fd
make distclean
cd ../..
code_sign=false use_carthage_cache=false ./bin/build_vimr.sh

Project Setup

Artifacts Hierarchy

VimR.app
+-- NvimView.framework
    +-- NVimView
    +-- runtime files for Neovim
    +-- NvimServer
        +-- libnvim
        +-- other libs for Neovim

Libraries for Neovim

  • The library libiconv is linked by the linker flag -liconv. The version bundled with macOS will be linked.
  • The library libintl is pre-built in third-party/libintl/lib and linked by "Other Linker Flags" of the NvimServer target.
  • Other libraries used by Neovim, which are automatically built by building libnvim, are linked by "Other Linker Flags" of the NvimServer target.

License

MIT


If you are here for VimR-MacVim, use the macvim/master branch and the version 0.8.0 (32).

You can’t perform that action at this time.