vimr/README.md

# VimR — Neovim GUI for macOS

[Download](https://github.com/qvacua/vimr/releases) • [Documentation](https://github.com/qvacua/vimr/wiki)

![Screenshot 1](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot1.png)
![Screenshot 2](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot2.png)

## 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](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: <https://matrix.to/#/#vimr:matrix.org>

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

* [RxMsgpackRpc](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMsgpackRpc.swift): Implementation of MsgpackRpc using RxSwift.
* [RxNeovimApi](https://github.com/qvacua/vimr/blob/develop/RxPack/RxNeovimApi.swift): RxSwift wrapper of Neovim API.
* [NvimView](https://github.com/qvacua/vimr/tree/develop/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:

```bash
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](DEVELOP.md).

## License

[MIT](https://github.com/qvacua/vimr/blob/master/LICENSE)
Update docs 2020-12-30 17:34:38 +03:00			`# VimR — Neovim GUI for macOS`
Initial commit with content - embed libnvim in an XPC-service - send some inputs to neovim and log the UI callbacks 2016-06-04 00:43:39 +03:00
Update docs 2020-12-30 17:34:38 +03:00			`[Download](https://github.com/qvacua/vimr/releases) • [Documentation](https://github.com/qvacua/vimr/wiki)`
Initial commit with content - embed libnvim in an XPC-service - send some inputs to neovim and log the UI callbacks 2016-06-04 00:43:39 +03:00
Update screenshot 2016-12-01 23:30:31 +03:00			`![Screenshot 1](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot1.png)`
Update README 2017-06-30 22:32:02 +03:00			`![Screenshot 2](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot2.png)`
Update README and add icon 2016-07-10 21:57:00 +03:00
GH-219 Update README with some planned features 2016-07-19 01:33:28 +03:00			`## About`
Update README and add icon 2016-07-10 21:57:00 +03:00
Update README 2023-11-22 15:42:54 +03:00			`Project VimR is a Neovim GUI for macOS written in Swift.`
readme and ignores 2023-10-29 23:50:52 +03:00
Adapt readme 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,`
Update docs 2020-12-30 17:34:38 +03:00			`but also use C/Objective-C when where appropriate.`
Update README and add icon 2016-07-10 21:57:00 +03:00
Update DEVELOP.md 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?`
Update README 2016-08-15 00:02:04 +03:00
Update docs 2020-12-30 17:34:38 +03:00			`- Play around with [Neovim](https://github.com/qvacua/neovim),`
Update README 2023-11-22 15:42:54 +03:00			`- play around with Swift (and especially with [RxSwift](https://github.com/ReactiveX/RxSwift)),`
			`- Play around with the main idea of Redux architecture, and`
Update README 2016-08-15 00:02:04 +03:00			`- (most importantly) have fun!`

Update README 2023-11-22 15:42:54 +03:00			`If you feel chatty, there is a chat room: <https://matrix.to/#/#vimr:matrix.org>`
Add chat room to README 2023-11-13 23:29:25 +03:00
Update DEVELOP.md 2021-12-13 20:47:02 +03:00			`If you want to support VimR financially, use [Github's Sponsor](https://github.com/sponsors/qvacua).`
Add github's sponsor button 2020-06-23 20:15:31 +03:00
Adapt readme 2020-02-07 19:37:47 +03:00			`## Download`

Update DEVELOP.md 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).`
Adapt readme 2020-02-07 19:37:47 +03:00
			`## Reusable Components`
Update README (SwiftNeoVim) 2016-08-16 23:44:15 +03:00
Update docs 2020-12-30 17:34:38 +03:00			`* [RxMsgpackRpc](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMsgpackRpc.swift): Implementation of MsgpackRpc using RxSwift.`
Update README 2019-03-29 23:51:37 +03:00			`* [RxNeovimApi](https://github.com/qvacua/vimr/blob/develop/RxPack/RxNeovimApi.swift): RxSwift wrapper of Neovim API.`
Update README 2023-11-22 15:42:54 +03:00			* [NvimView](https://github.com/qvacua/vimr/tree/develop/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.
Update README (SwiftNeoVim) 2016-08-16 23:44:15 +03:00
Update README 2019-03-05 14:44:10 +03:00			`## Some Features`
GH-221 Update README 2016-08-01 23:10:41 +03:00
Update README 2017-03-30 22:18:32 +03:00			`* Markdown preview`
Update README 2017-04-18 21:48:03 +03:00			`* Generic HTML preview (retains the scroll position when reloading)`
Update README.md 2016-09-09 13:51:07 +03:00			`* Fuzzy file finder a la Xcode's "Open Quickly..."`
Update README 2019-03-05 14:44:10 +03:00			`* Trackpad support: Pinching for zooming and two-finger scrolling.`
GH-221 Update README 2016-08-01 23:10:41 +03:00			`* Ligatures: Turned off by default. Turn it on in the Preferences.`
Update README 2016-09-26 20:05:50 +03:00			`* Command line tool.`
Update README.md 2016-10-06 23:37:46 +03:00			`* (Simple) File browser`
Update README 2017-04-18 21:48:03 +03:00			`* Flexible workspace model a la JetBrain's IDEs`
GH-219 Update README with some planned features 2016-07-19 01:33:28 +03:00
Initial commit with content - embed libnvim in an XPC-service - send some inputs to neovim and log the UI callbacks 2016-06-04 00:43:39 +03:00			`## How to Build`

Update DEVELOP.md 2021-12-13 20:47:02 +03:00			Clone this repository. Install `homebrew`, then in the project root:
Call vim_input on the main_loop 2016-06-06 19:25:03 +03:00
Initial commit with content - embed libnvim in an XPC-service - send some inputs to neovim and log the UI callbacks 2016-06-04 00:43:39 +03:00			```bash
Mention 'git submodule' commands required to build 2022-01-03 19:20:18 +03:00			`git submodule init`
			`git submodule update`

Restructure the project 2017-12-03 11:59:15 +03:00			`xcode-select --install # install the Xcode command line tools, if you haven't already`
			`brew bundle`
Call vim_input on the main_loop 2016-06-06 19:25:03 +03:00
Remove Carthage 2023-11-24 13:25:36 +03:00			`clean=true notarize=false ./bin/build_vimr.sh`
Update DEVELOP.md 2021-12-13 20:47:02 +03:00			`# VimR.app will be placed in ./build/Build/Products/Release/`
Update README.md 2016-06-07 00:29:36 +03:00			```

Update DEVELOP.md 2021-12-13 20:47:02 +03:00			`## Development`
Update README.md 2016-06-07 00:29:36 +03:00
Update DEVELOP.md 2021-12-13 20:47:02 +03:00			`See [DEVELOP.md](DEVELOP.md).`
Update README and add icon 2016-07-10 21:57:00 +03:00
			`## License`

Update README.md 2016-09-10 15:57:56 +03:00			`[MIT](https://github.com/qvacua/vimr/blob/master/LICENSE)`
Update README.md 2016-11-06 12:34:27 +03:00