mirror of
https://github.com/qvacua/vimr.git
synced 2024-11-26 21:55:21 +03:00
Update docs
This commit is contained in:
parent
588d9579bb
commit
c937345e2d
42
README.md
42
README.md
@ -1,28 +1,24 @@
|
||||
VimR — Neovim Refined
|
||||
==================
|
||||
# VimR — Neovim GUI for macOS
|
||||
|
||||
![App Icon](https://raw.github.com/qvacua/vimr/master/resources/vimr-app-icon.png)
|
||||
|
||||
[Download](https://github.com/qvacua/vimr/releases) • [Documentation](https://github.com/qvacua/vimr/wiki) • <http://vimr.org>
|
||||
[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 0](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot0.png)
|
||||
![Screenshot 2](https://raw.githubusercontent.com/qvacua/vimr/develop/resources/screenshot2.png)
|
||||
|
||||
## About
|
||||
|
||||
Project VimR is a (YA) Neovim GUI for macOS.
|
||||
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 Objective-C when its C-nature helps.
|
||||
but also use C/Objective-C when where appropriate.
|
||||
|
||||
There are other Neovim GUIs for macOS, e.g. [NyaoVim](https://github.com/rhysd/NyaoVim), [neovim-dot-app](https://github.com/rogual/neovim-dot-app), [Oni](https://www.onivim.io), etc., so why?
|
||||
|
||||
- Play around (obviously) with [Neovim](https://github.com/qvacua/neovim),
|
||||
- Play around with [Neovim](https://github.com/qvacua/neovim),
|
||||
- play around with Swift (and especially with [RxSwift](https://github.com/ReactiveX/RxSwift)), and
|
||||
- (most importantly) have fun!
|
||||
|
||||
If you want to support VimR financially, click the [Github's Sponsor](https://github.com/sponsors/qvacua)
|
||||
If you want to support VimR financially, use [Github's Sponsor](https://github.com/sponsors/qvacua)
|
||||
or [Bountysource](https://www.bountysource.com/teams/vimr).
|
||||
|
||||
## Download
|
||||
@ -32,9 +28,9 @@ Pre-built binaries can be found under [Releases](https://github.com/qvacua/vimr/
|
||||
## Reusable Components
|
||||
|
||||
* [RxMessagePort](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMessagePort.swift): RxSwift wrapper for local and remote `CFMessagePort`.
|
||||
* [RxMsgpackRpc](https://github.com/qvacua/vimr/blob/develop/RxPack/RxMsgpackRpc.swift): implementation of MsgpackRpc using RxSwift.
|
||||
* [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): Cocoa Framework which bundles everything, e.g. Neovim's `runtime`-files, needed to embed Neovim in a Cocoa App.
|
||||
* [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.
|
||||
|
||||
## Some Features
|
||||
|
||||
@ -65,17 +61,6 @@ brew bundle
|
||||
code_sign=false use_carthage_cache=false ./bin/build_vimr.sh # VimR.app will be placed in build/Build/Products/Release/
|
||||
```
|
||||
|
||||
If the build fails for some reason, do the following and build again:
|
||||
|
||||
```
|
||||
cd NvimView/neovim
|
||||
git reset --hard @
|
||||
git clean -fd
|
||||
make distclean
|
||||
cd ../..
|
||||
code_sign=false use_carthage_cache=false ./bin/build_vimr.sh
|
||||
```
|
||||
|
||||
## Project Setup
|
||||
|
||||
### Artifacts Hierarchy
|
||||
@ -83,18 +68,17 @@ code_sign=false use_carthage_cache=false ./bin/build_vimr.sh
|
||||
```
|
||||
VimR.app
|
||||
+-- NvimView.framework
|
||||
+-- NVimView
|
||||
+-- runtime files for Neovim
|
||||
+-- NvimServer
|
||||
+-- libnvim
|
||||
+-- other libs for Neovim
|
||||
+-- NvimView
|
||||
+-- NvimServer binary (copied by the build script)
|
||||
+-- runtime files for Neovim (copied by the build script)
|
||||
```
|
||||
|
||||
### Libraries for Neovim
|
||||
### How to develop
|
||||
|
||||
* The library `libiconv` is linked by the linker flag `-liconv`. The version bundled with macOS will be linked.
|
||||
* The library `libintl` is pre-built in `third-party/libintl/lib` and linked by "Other Linker Flags" of the NvimServer target.
|
||||
* Other libraries used by Neovim, which are automatically built by building `libnvim`, are linked by "Other Linker Flags" of the NvimServer target.
|
||||
See [DEVELOP.md](docs/develop.md).
|
||||
|
||||
## License
|
||||
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 305 KiB |
Binary file not shown.
Before Width: | Height: | Size: 664 KiB After Width: | Height: | Size: 720 KiB |
Binary file not shown.
Before Width: | Height: | Size: 448 KiB After Width: | Height: | Size: 934 KiB |
Loading…
Reference in New Issue
Block a user