2020-12-30 17:34:38 +03:00
# VimR — Neovim GUI for macOS
2016-06-04 00:43:39 +03:00
2020-12-30 17:34:38 +03:00
[Download ](https://github.com/qvacua/vimr/releases ) • [Documentation ](https://github.com/qvacua/vimr/wiki )
2016-06-04 00:43:39 +03:00
2016-12-01 23:30:31 +03:00
2017-06-30 22:32:02 +03:00
2016-07-10 21:57:00 +03:00
2016-07-19 01:33:28 +03:00
## About
2016-07-10 21:57:00 +03:00
2020-12-30 17:34:38 +03:00
Project VimR is a Neovim GUI for macOS.
2023-10-29 23:50:52 +03:00
2020-02-07 19:37:47 +03:00
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,
2020-12-30 17:34:38 +03:00
but also use C/Objective-C when where appropriate.
2016-07-10 21:57:00 +03:00
2021-12-13 20:47:02 +03:00
There are other Neovim GUIs for macOS, see the [list ](https://github.com/neovim/neovim/wiki/Related-projects#gui ), so why?
2016-08-15 00:02:04 +03:00
2020-12-30 17:34:38 +03:00
- Play around with [Neovim ](https://github.com/qvacua/neovim ),
2020-02-07 19:37:47 +03:00
- play around with Swift (and especially with [RxSwift ](https://github.com/ReactiveX/RxSwift )), and
2016-08-15 00:02:04 +03:00
- (most importantly) have fun!
2023-11-13 23:29:25 +03:00
We have a chat room: < https: / / matrix . to / # / # vimr:matrix . org >
2021-12-13 20:47:02 +03:00
If you want to support VimR financially, use [Github's Sponsor ](https://github.com/sponsors/qvacua ).
2020-06-23 20:15:31 +03:00
2020-02-07 19:37:47 +03:00
## Download
2021-12-13 20:47:02 +03:00
Pre-built Universal signed and notarized binaries can be found under [Releases ](https://github.com/qvacua/vimr/releases ).
2020-02-07 19:37:47 +03:00
## Reusable Components
2016-08-16 23:44:15 +03:00
2019-03-29 23:51:37 +03:00
* [RxMessagePort ](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMessagePort.swift ): RxSwift wrapper for local and remote `CFMessagePort` .
2020-12-30 17:34:38 +03:00
* [RxMsgpackRpc ](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMsgpackRpc.swift ): Implementation of MsgpackRpc using RxSwift.
2019-03-29 23:51:37 +03:00
* [RxNeovimApi ](https://github.com/qvacua/vimr/blob/develop/RxPack/RxNeovimApi.swift ): RxSwift wrapper of Neovim API.
2020-12-30 17:34:38 +03:00
* [NvimView ](https://github.com/qvacua/vimr/tree/develop/NvimView ): SwiftPM module which bundles everything, e.g. Neovim's `runtime` -files, needed to embed Neovim in a Cocoa App.
2016-08-16 23:44:15 +03:00
2019-03-05 14:44:10 +03:00
## Some Features
2016-08-01 23:10:41 +03:00
2017-03-30 22:18:32 +03:00
* Markdown preview
2017-04-18 21:48:03 +03:00
* Generic HTML preview (retains the scroll position when reloading)
2016-09-09 13:51:07 +03:00
* Fuzzy file finder a la Xcode's "Open Quickly..."
2019-03-05 14:44:10 +03:00
* Trackpad support: Pinching for zooming and two-finger scrolling.
2016-08-01 23:10:41 +03:00
* Ligatures: Turned off by default. Turn it on in the Preferences.
2016-09-26 20:05:50 +03:00
* Command line tool.
2016-10-06 23:37:46 +03:00
* (Simple) File browser
2017-04-18 21:48:03 +03:00
* Flexible workspace model a la JetBrain's IDEs
2016-07-19 01:33:28 +03:00
2016-06-04 00:43:39 +03:00
## How to Build
2021-12-13 20:47:02 +03:00
Clone this repository. Install `homebrew` , then in the project root:
2016-06-06 19:25:03 +03:00
2016-06-04 00:43:39 +03:00
```bash
2022-01-03 19:20:18 +03:00
git submodule init
git submodule update
2017-12-03 11:59:15 +03:00
xcode-select --install # install the Xcode command line tools, if you haven't already
brew bundle
2016-06-06 19:25:03 +03:00
2022-06-26 20:01:16 +03:00
clean=true notarize=false use_carthage_cache=false ./bin/build_vimr.sh
2021-12-13 20:47:02 +03:00
# VimR.app will be placed in ./build/Build/Products/Release/
2016-06-07 00:29:36 +03:00
```
2021-12-13 20:47:02 +03:00
## Development
2016-06-07 00:29:36 +03:00
2021-12-13 20:47:02 +03:00
See [DEVELOP.md ](DEVELOP.md ).
2016-07-10 21:57:00 +03:00
## License
2016-09-10 15:57:56 +03:00
[MIT ](https://github.com/qvacua/vimr/blob/master/LICENSE )
2016-11-06 12:34:27 +03:00
