Swift Objective-C CSS Shell Python HTML Other
Switch branches/tags
Clone or download

README.md

VimR — Neovim Refined

App Icon

Downloadhttp://vimr.org

Bountysource Chat at https://gitter.im/vimr/vimr Travis builds Stories in Ready

Screenshot 1 Screenshot 0 Screenshot 2

About

Project VimR is an attempt to refine the Neovim experience (or just YA Neovim GUI for mac OS). 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 working Neovim GUIs for OS X, e.g. NyaoVim, neovim-dot-app, etc., why another?

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

NvimView

NvimView is VimR's Cocoa Framework which bundles everything, e.g. Neovim's runtime-files, needed to embed Neovim in a Cocoa App. See the wiki for more details.


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.

Download

Pre-built binaries can be found under Releases.

Implemented Features

  • Multiple windows.
  • Basic input including Emojis and Hangul (+Hanja): We don't know whether other input systems work...
  • Markdown preview
  • Generic HTML preview (retains the scroll position when reloading)
  • Basic mouse support: Left button actions and scrolling.
  • Fuzzy file finder a la Xcode's "Open Quickly..."
  • Basic trackpad support: Pinching for zooming and two-finger scrolling.
  • Ligatures: Turned off by default. Turn it on in the Preferences.
  • Basic File and Edit menu items.
  • Command line tool.
  • (Simple) File browser
  • Flexible workspace model a la JetBrain's IDEs

We will gradually create feature issues with more details. For the current status see the project board.

How to Build

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

git submodule init
git submodule update

You have to use Xcode 9. First install homebrew, then in the project root:

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

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

Project Setup

Artifacts Hierarchy

VimR.app
+-- NvimView.framework
    +-- NeoVimView
    +-- 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).