XVim2

XVim2 (or 'XVim for Xcode 9 and above') is a Vim plugin for Xcode. The plugin intends to offer a compelling Vim experience without the need to give up any Xcode features.

Xcode 9 Users, follow the installation instructions below.
Xcode 8 or below, you should use XVim
Google Group for XVim developers has been created.

INSTALL

Sign Xcode with your own certificate. You can find instructions in SIGNING_Xcode.md.
Download the source code or clone the repo.

$ git clone https://github.com/XVimProject/XVim2.git

Confirm xcode-select points to your Xcode

$ xcode-select -p
/Applications/Xcode.app/Contents/Developer

If this doesn't show your Xcode application path, use xcode-select -s to set.

make

$ make

If you see something like

XVim hasn't confirmed the compatibility with your Xcode, Version X.X
Do you want to compile XVim with support Xcode Version X.X at your own risk?

Press y if you want to use XVim with your Xcode version (even it is not confirmed it works)

Create .xvimrc as you need.
Launch Xcode. You'll be asked if you load XVim. Press 'Yes' to it. If you press 'No' by mistake, close the Xcode and execute the following from a terminal

defaults delete  com.apple.dt.Xcode DVTPlugInManagerNonApplePlugIns-Xcode-X.X     (X.X is your Xcode version)

Relaunch Xcode.

Branches and Releases

XVim has several branches and releases. Usually you only need to download one of 'releases' and use it. Here is an explanation about each release and branch.

Releases(tags) : Releases are tags on master branch. All the code and documents on these tags are well arranged. Usual XVim user should use one of releases.
master : Most stable branch. Critical bug fixes and stable feature developed in 'develop' branch are merged into 'master'. If you find a critical bug in a release, try latest 'master' branch.
develop : New features and non critical bug fixes are merged into this branch. If you want experimental features use this branch.

Any other branches are temporary branches to develop features or bug fixes which will be merged into 'develop' branch after all. Any pull requests should be made to 'develop' branch.

Uninstall

$ make uninstall

Manual uninstall

Delete the following directory: $HOME/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins/XVim.xcplugin

Feature list

See separate FeatureList.md

Bug reports

Unfortunately XVim sometimes crashes Xcode. We are working on eliminating all the bugs, but it's really hard work. It helps greatly when we have your bug reports, with the following information:

Crash information ( Xcode shows threads stack trace when crashes. Copy them. )
The operations you did to cause the crash ( series of key strokes or mouse clicks )
The text you were manipulating
Xcode version
XVim version ( Version number of the revision you built )

When it is hard to solve a problem with information above, take debug log according to the following movie please.

How to get XVim debug log

We appreciate if you write test case for the bug. Read "Write test" section in Documents/Developsers/PullRequest.md how to write test case. You do not need to update any source code but just write 7 items explained there in an issue you create.

Bountysource

XVim supports Bountysource. If you want to solve your issue sooner make bounty on your issue is one option. A contributer should work on it preferentially (not guaranteed though). To make bounty visit following link and go to "Issue" tab. Select your issue and make bounty on it.

https://www.bountysource.com/teams/xvim

Contributing Guidelines

See separate CONTRIBUTING.md

Donations

If you think the plugin is useful, please donate. There are two options you can take. Donate for Japan Earthquake and Tsunami Relief or back the project via BountySource. There is no rule that you cannot take both :) .

Japan Earthquake and Tsunami Relief

Since I do not intend make money from this project, I am directing donations to the people suffering from the damage of the 2011 Tohoku earthquake and tsunami in Japan.

Please donate directly through the Paypal donation site below, as this will put more money to good use by reducing the transfer fee.

https://www.paypal-donations.com/pp-charity/web.us/campaign.jsp?cid=-12

Since no messages are sent when you donate from the paypal link, you could also write a donation message on Message Board. I(we) would really appreciate it, and it will really motivate me(us)!

BountySource

If you like to help and enhance the project directly consider backing this project via BountySource. You can back the team (which means you support the entire project) or you can make bounty on a specific issue. (If you have any bugs to be fixed or features to be implemented not in issues yet you can make one.)

Contributors

See contributors page in github repository. https://github.com/XVimProject/XVim2/contributors

License

MIT License

yixiang/XVim2