qvacua/vimr
1
1
Fork 0
mirror of https://github.com/qvacua/vimr.git synced 2024-11-23 01:54:31 +03:00
Code Issues Projects Releases Wiki Activity

Update readme and develop

Browse Source
This commit is contained in:
Tae Won Ha 2024-05-30 11:04:26 +09:00
parent 601f2b151b
commit bdcde67821
No known key found for this signature in database
GPG Key ID: E40743465B5B8B44
2 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
DEVELOP.md
View File

@ -1,18 +1,26 @@
## How to develop
In most cases, you can use the pre-built universal Neovim build by running
VimR includes a stock Neovim. From Neovim `v0.10.0`, we provide pre-built universal Neovim,
see for instance <https://github.com/qvacua/vimr/releases/tag/neovim-v0.10.0-20240527.232810>.
In most cases, you can use the pre-built Neovim.
Run the following
```bash
clean=true for_dev=false ./bin/build_nvimserver.sh
```
If you want to build Neovim locally, i.e., no universal build, you can use
to download and place the files in the appropriate places.
Now, you can just *run* VimR target in Xcode.
If you want to build Neovim locally, you can use
```bash
clean=true for_dev=true ./bin/build_nvimserver.sh
```
This is used when generating source since we need some generated header files.
Afterwards, you can run VimR target in Xcode.
(This is used when generating source since we need some generated header files.)
### How to enable the Debug menu in Release build

21
README.md
View File

@ -7,11 +7,10 @@
## About
Project VimR is a Neovim GUI for macOS written in Swift.
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.
The goal is to build an editor that uses Neovim inside with some of the convenience
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?
@ -30,9 +29,11 @@ Pre-built Universal signed and notarized binaries can be found under [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.
* [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
@ -50,12 +51,10 @@ Pre-built Universal signed and notarized binaries can be found under [Releases](
Clone this repository. Install `homebrew`, then in the project root:
```bash
git submodule init
git submodule update
git submodule update --init
xcode-select --install # install the Xcode command line tools, if you haven't already
brew bundle
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/
```