qvacua/vimr
1
1
Fork 0
mirror of https://github.com/qvacua/vimr.git synced 2024-12-28 08:13:17 +03:00
Code Issues Projects Releases Wiki Activity
VimR — Neovim GUI for macOS in Swift
3,838 Commits 6 Branches 428 Tags 39 MiB
Swift 90.5%
CSS 2.7%
Shell 2.5%
Python 2.2%
HTML 0.7%
Other 1.4%
3ebb245dd9
Go to file
Tae Won Ha 3ebb245dd9
Update README
2021-12-12 20:46:25 +01:00
.github Add vimr-deps download script 2021-12-12 20:39:24 +01:00
bin Update README 2021-12-12 20:46:25 +01:00
ci Add description 2020-02-15 08:32:41 +01:00
Commons Update SPM deps 2021-11-04 22:06:28 +01:00
docs docs: chinese pinyin input method 2021-10-31 17:41:30 +08:00
NvimServer@5499046eef Update neovim 2021-12-01 19:25:42 +01:00
NvimView Update neovim to 0.6.0 2021-12-01 19:09:59 +01:00
resources Add vimr-deps download script 2021-12-12 20:39:24 +01:00
RxPack Update neovim to 0.6.0 2021-12-01 19:09:59 +01:00
Tabs Remove Xcode warnings 2021-06-18 08:57:57 +02:00
VimR Add vimr-deps download script 2021-12-12 20:39:24 +01:00
VimR.xcworkspace Update SPM deps 2021-11-04 22:06:28 +01:00
Workspace Update deps 2021-06-18 08:06:38 +02: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 Add NvimServer as submodule and add a script for local dev 2020-08-18 19:20:40 +02:00
.swiftformat Reformat using swiftformat 2020-09-18 16:01:55 +02:00
.swiftlint.yml Add swiftlint yaml 2020-12-25 21:59:50 +01:00
.travis.yml.bak Disable travis for time being 2019-02-02 18:50:54 +01:00
appcast_snapshot.xml Update snapshot appcast 2021-12-01 19:42:16 +01:00
appcast.xml Update minimum system requirement in appcast 2021-11-06 14:35:17 +01:00
Brewfile Add SDKROOT when building libnvim 2020-03-26 22:39:58 +01:00
Cartfile Update deps and release notes 2021-11-30 18:50:13 +01:00
Cartfile.resolved Update version to SNAPSHOT-20211201.192602 2021-12-01 19:27:12 +01:00
LICENSE Initial commit with content 2016-06-03 23:43:39 +02:00
README.md Update docs 2020-12-30 15:34:58 +01:00

README.md

VimR — Neovim GUI for macOS

Download • Documentation

Screenshot 1 Screenshot 2

About

Project VimR is a 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 C/Objective-C when where appropriate.

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

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

If you want to support VimR financially, use 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: SwiftPM module 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/

Project Setup

Artifacts Hierarchy

VimR.app
+-- NvimView.framework
    +-- NvimServer
        +-- libnvim
        +-- other libs for Neovim
    +-- NvimView
        +-- NvimServer binary (copied by the build script)
        +-- runtime files for Neovim (copied by the build script)

How to develop

See DEVELOP.md.

License

MIT

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