Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qvacua/vimr
VimR — Neovim GUI for macOS in Swift
https://github.com/qvacua/vimr
cocoa macos neovim neovim-clients neovim-experience neovim-guis objective-c swift vim
Last synced: 2 days ago
JSON representation
VimR — Neovim GUI for macOS in Swift
- Host: GitHub
- URL: https://github.com/qvacua/vimr
- Owner: qvacua
- License: mit
- Created: 2014-02-28T21:31:38.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T18:25:55.000Z (2 months ago)
- Last Synced: 2024-10-29T10:13:28.164Z (about 1 month ago)
- Topics: cocoa, macos, neovim, neovim-clients, neovim-experience, neovim-guis, objective-c, swift, vim
- Language: Swift
- Homepage: https://twitter.com/VimRefined
- Size: 35.1 MB
- Stars: 6,668
- Watchers: 117
- Forks: 218
- Open Issues: 297
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred-test - qvacua/vimr - VimR — Neovim GUI for macOS in Swift (Swift)
- open-source-mac-os-apps - VimR - Refined Neovim experience for macOS. ![swift_icon] (Applications / Editors)
- open-source-mac-os-apps - VimR - Refined Neovim experience for macOS. ![swift_icon] (Applications / Editors)
- awesome-swift-macos-apps - VimR - Refined Neovim experience for macOS. (Editors / Text)
- awesome-swift-macos-apps - VimR - Refined Neovim experience for macOS. (Editors / Text)
README
# VimR — Neovim GUI for macOS
[Download](https://github.com/qvacua/vimr/releases) • [Documentation](https://github.com/qvacua/vimr/wiki)
## About
VimR is a Neovim GUI for macOS written in Swift.
The goal is to build an editor that uses Neovim inside with some of the convenient
GUI features similar to those present in modern editors.
There are other Neovim GUIs for macOS, see the [list](https://github.com/neovim/neovim/wiki/Related-projects#gui), so why?
- Play around with [Neovim](https://github.com/qvacua/neovim),
- play around with Swift (and especially with [RxSwift](https://github.com/ReactiveX/RxSwift)),
- Play around with the main idea of Redux architecture, and
- (most importantly) have fun!
If you feel chatty, there is a chat room:
If you want to support VimR financially, use [Github's Sponsor](https://github.com/sponsors/qvacua).
## Download
Pre-built Universal signed and notarized binaries can be found under [Releases](https://github.com/qvacua/vimr/releases).
## Reusable Components
* [NvimView](https://github.com/qvacua/vimr/tree/master/NvimView): SwiftPM module containing
an NSView which bundles everything, e.g., Neovim binary and its `runtime`-files, needed to
embed Neovim in a Cocoa App.
* [RxMsgpackRpc](https://github.com/qvacua/vimr/tree/master/RxPack/Sources/RxPack/RxMsgpackRpc.swift): Implementation of MsgpackRpc using RxSwift.
* [RxNeovimApi](https://github.com/qvacua/vimr/tree/master/RxPack/Sources/RxNeovim): RxSwift wrapper of Neovim API.
## 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
Clone this repository. Install `homebrew`, then in the project root:
```bash
git submodule update --init
xcode-select --install # install the Xcode command line tools, if you haven't already
brew bundle # install dependencies, e.g., build tools for Neovim
clean=true notarize=false ./bin/build_vimr.sh
# VimR.app will be placed in ./build/Build/Products/Release/
```
## Development
See [DEVELOP.md](DEVELOP.md).
## License
[MIT](https://github.com/qvacua/vimr/blob/master/LICENSE)