qvacua/vimr
1
1
Fork 0
mirror of https://github.com/qvacua/vimr.git synced 2024-12-25 23:02:35 +03:00
Code Issues Projects Releases Wiki Activity
VimR — Neovim GUI for macOS in Swift
4,301 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%
a7a9fa04a9
Go to file
Tae Won Ha a7a9fa04a9
Update release notes
2023-12-10 15:36:59 +01:00
.github Remove unnec' env var 2023-11-25 15:19:28 +01:00
bin Remove accidentally committed files 2023-12-03 12:07:20 +01:00
Commons remove warnings 2023-11-12 10:00:47 -08:00
docs Update DEVELOP.md 2021-12-13 18:47:02 +01:00
Ignore swiftformat Ignore 2023-11-10 21:30:31 +01:00
Neovim@c675e51c2f Update neovim 2023-12-10 15:34:13 +01:00
NvimView Remove unnec' version check 2023-12-10 15:33:28 +01:00
resources Update release notes 2023-12-10 15:36:59 +01:00
RxPack check versions on starting neovim via the pipe 2023-12-04 12:35:33 -08:00
Tabs Slightly refactor 2023-11-22 13:03:05 +01:00
VimR Update sparkle 2023-12-04 19:20:11 +01:00
VimR.xcworkspace Update sparkle 2023-12-04 19:20:11 +01:00
Workspace Merge remote-tracking branch 'origin/pr/745' 2023-11-05 19:49:33 +01:00
.gitattributes Add waiting script for notarization 2019-12-22 21:45:42 +01:00
.gitignore Ignore third-party folder 2023-12-03 12:09:25 +01:00
.gitmodules Use stock Neovim repository as submodule 2023-11-13 22:10:43 +01:00
.swiftformat Reformat 2022-12-15 15:25:24 +09:00
.swiftlint.yml Add Airbnb's swiftlint rules 2021-12-24 09:54:18 +01:00
appcast_snapshot.xml Update appcast 2023-11-22 13:34:26 +01:00
appcast.xml Update appcast 2023-11-22 13:34:26 +01:00
Brewfile Remove Carthage 2023-11-24 11:25:36 +01:00
DEVELOP.md Update DEVELOP 2023-11-22 13:48:41 +01:00
LICENSE Implement VCS ignoring in Swift and use fzy to fuzzy match 2022-06-16 15:26:39 +02:00
README.md Remove Carthage 2023-11-24 11:25:36 +01:00

README.md

VimR — Neovim GUI for macOS

Download • Documentation

Screenshot 1 Screenshot 2

About

Project VimR is a Neovim GUI for macOS written in Swift.

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, see the list, so why?

  • Play around with Neovim,
  • play around with Swift (and especially with RxSwift),
  • Play around with the main idea of Redux architecture, and
  • (most importantly) have fun!

If you feel chatty, there is a chat room: https://matrix.to/#/#vimr:matrix.org

If you want to support VimR financially, use Github's Sponsor.

Download

Pre-built Universal signed and notarized binaries can be found under Releases.

Reusable Components

  • RxMsgpackRpc: Implementation of MsgpackRpc using RxSwift.
  • RxNeovimApi: RxSwift wrapper of Neovim API.
  • 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.

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:

git submodule init
git submodule update

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

clean=true notarize=false ./bin/build_vimr.sh
# VimR.app will be placed in ./build/Build/Products/Release/

Development

See DEVELOP.md.

License

MIT