qvacua/vimr
1
1
Fork 0
mirror of https://github.com/qvacua/vimr.git synced 2024-11-27 14:14:19 +03:00
Code Issues Projects Releases Wiki Activity
VimR — Neovim GUI for macOS in Swift
3,459 Commits 6 Branches 426 Tags 39 MiB
Swift 90.6%
CSS 2.6%
Shell 2.5%
Python 2.2%
HTML 0.7%
Other 1.4%
c3be5b6441
Go to file
Tae Won Ha c3be5b6441
Refactor slightly 
and format with swiftformat
2020-07-05 20:15:42 +02:00
.github Try github sponsors 2020-06-23 19:12:57 +02:00
bin Exit when not updating appcast on develop 2020-06-22 18:09:26 +02:00
ci Add description 2020-02-15 08:32:41 +01:00
docs Add a note on text input 2016-07-03 15:55:11 +02:00
NvimView Bump version: snapshot/355 2020-07-05 10:55:32 +02:00
resources Update release notes 2020-07-05 10:40:39 +02:00
RxPack Refactor slightly 2020-07-05 20:15:42 +02:00
third-party Update deps 2020-02-14 22:32:50 +01:00
VimR Bump version: snapshot/355 2020-07-05 10:55:32 +02:00
VimR.xcworkspace Add RxMessagePort into workspace 2019-03-26 22:24:02 +01:00
.gitattributes Add waiting script for notarization 2019-12-22 21:45:42 +01:00
.gitignore Add a dev target 2019-03-14 09:56:23 +01:00
.gitmodules Restructure the project 2017-12-03 09:59:15 +01:00
.swiftformat Refactor slightly 2020-07-05 20:15:42 +02:00
.travis.yml.bak Disable travis for time being 2019-02-02 18:50:54 +01:00
appcast_snapshot.xml Bump appcast(s) to SNAPSHOT-355 2020-07-05 10:56:04 +02:00
appcast.xml Bump appcast(s) to v0.33.1-354 2020-06-30 22:35:22 +02:00
Brewfile Add SDKROOT when building libnvim 2020-03-26 22:39:58 +01:00
Cartfile Update deps 2020-06-20 14:04:51 +02:00
Cartfile.resolved Update deps 2020-06-20 14:04:51 +02:00
LICENSE Initial commit with content 2016-06-03 23:43:39 +02:00
README.md Add github's sponsor button 2020-06-23 19:21:57 +02:00

README.md

VimR — Neovim Refined

App Icon

Download • Documentation • http://vimr.org

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!

If you want to support VimR financially, click the Github's Sponsor or Bountysource.

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.

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).