diff --git a/README.md b/README.md index b7f464c1ea..4b8c7d5c4b 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,128 @@ # neovim ([bountysource fundraiser](https://www.bountysource.com/fundraisers/539-neovim-first-iteration)) -### Introduction -Vim is a powerful text editor with a big community that is constantly growing. Even though the editor is about two decades old, people still extend and want to improve it, mostly using vimscript or one of the supported scripting languages. +## Introduction -### Problem +Vim is a powerful text editor with a big community that is constantly +growing. Even though the editor is about two decades old, people still extend +and want to improve it, mostly using vimscript or one of the supported scripting +languages. -Over its more than 20 years of life, vim has accumulated about 300k lines of scary C89 code that very few people understand or have the guts to mess with. +## Problem -Another issue, is that as the only person responsible for maintaining vim's big codebase, Bram Moolenaar has to be extra-careful before accepting patches, because once merged, the new code will be his responsibility. +Over its more than 20 years of life, vim has accumulated about 300k lines of +scary C89 code that very few people understand or have the guts to mess with. -These problems make it very difficult to have new features and bug fixes merged into the core. Vim just can't keep up with the development speed of its plugin ecosystem. +Another issue is that as the only person responsible for maintaining vim's big +codebase, Bram Moolenaar has to be extra careful before accepting patches, +because once merged, the new code will be his responsibility. -### Solution +These problems make it very difficult to have new features and bug fixes merged +into the core. Vim just can't keep up with the development speed of its plugin +ecosystem. -Neovim is a project that seeks to aggressively refactor vim source code in order to achieve the following goals: +## Solution -- Simplify maintenance to improve the speed that bug fixes and features get merged. +Neovim is a project that seeks to aggressively refactor vim source code in order +to achieve the following goals: + +- Simplify maintenance to improve the speed that bug fixes and features get + merged. - Split the work between multiple developers. -- Enable the implementation of new/modern user interfaces without any modifications to the core source. -- Improve the extensibility power with a new plugin architecture based on coprocesses. Plugins will be written in any programming language without any explicit support from the editor. +- Enable the implementation of new/modern user interfaces without any + modifications to the core source. +- Improve the extensibility power with a new plugin architecture based on + coprocesses. Plugins will be written in any programming language without + any explicit support from the editor. -By achieving those goals new developers will soon join the community, consequently improving the editor for all users. +By achieving those goals new developers will soon join the community, +consequently improving the editor for all users. -It is important to emphasize that this is not a project to rewrite vim from scratch or transform it into an IDE (though the new features provided will enable IDE-like distributions of the editor). The changes implemented here should have little impact on vim's editing model or vimscript in general. Most vimscript plugins should continue to work normally. +It is important to emphasize that this is not a project to rewrite vim from +scratch or transform it into an IDE (though the new features provided will +enable IDE-like distributions of the editor). The changes implemented here +should have little impact on vim's editing model or vimscript in general. Most +vimscript plugins should continue to work normally. -The following topics contain brief explanations of the major changes (and motivations) that will be performed in the first iteration: +The following topics contain brief explanations of the major changes (and +motivations) that will be performed in the first iteration: -* Migrate to a cmake-based build -* Legacy support and compile-time features -* Platform-specific code -* New plugin architecture -* New GUI architecture -* Development on github +* [#build](**Migrate to a cmake-based build**) +* [#legacy](**Legacy support and compile-time features**) +* [#platform](**Platform-specific code**) +* [#plugins](**New plugin architecture**) +* [#gui](**New GUI architecture**) +* [#development](**Development on GitHub**) -##### Migrate to a cmake-based build +### Migrate to a CMake-based build -The source tree has dozens (if not hundreds) of files dedicated to building vim with on various platforms with different configurations, and many of these files look abandoned or outdated. Most users don't care about selecting individual features and just compile using '--with-features=huge', which still generates an executable that is small enough even for lightweight systems by today's standards. +The source tree has dozens (if not hundreds) of files dedicated to building vim +with on various platforms with different configurations, and many of these files +look abandoned or outdated. Most users don't care about selecting individual +features and just compile using `--with-features=huge`, which still generates an +executable that is small enough even for lightweight systems by today's +standards. -All those files will be removed and vim will be built using [cmake](http://www.cmake.org), a modern build system that generates build scripts for the most relevant platforms. +All those files will be removed and vim will be built using [CMake][], a modern +build system that generates build scripts for the most relevant platforms. + +[CMake]: http://cmake.org/ -##### Legacy support and compile-time features +### Legacy support and compile-time features -Vim has a significant amount of code dedicated to supporting legacy systems and compilers. All that code increases the maintenance burden and will be removed. +Vim has a significant amount of code dedicated to supporting legacy systems and +compilers. All that code increases the maintenance burden and will be removed. -Most optional features will no longer be optional (see above), with the exception of some broken and useless features (eg: netbeans integration, sun workshop) which will be removed permanently. Vi emulation will also be removed (setting 'nocompatible' will be a no-op). +Most optional features will no longer be optional (see above), with the +exception of some broken and useless features (e.g.: NetBeans and Sun WorkShop +integration) which will be removed permanently. Vi emulation will also be +removed (setting `nocompatible` will be a no-op). -These changes wont affect most users. Those that only have a C89 compiler installed or use vim on legacy systems such as Amiga, BeOS or MSDOS will have two options: +These changes won't affect most users. Those that only have a C89 compiler +installed or use vim on legacy systems such as Amiga, BeOS or MS-DOS will +have two options: - Upgrade their software - Continue using vim -##### Platform-specific code +### Platform-specific code -Most of the platform-specific code will be removed and [libuv](https://github.com/joyent/libuv) will be used to handle system differences. +Most of the platform-specific code will be removed and [libuv][] will be used to +handle system differences. -libuv is a modern multi-platform library with functions to perform common system tasks, and supports most unixes and windows, so the vast majority of vim's community will be covered. +libuv is a modern multi-platform library with functions to perform common system +tasks, and supports most unixes and windows, so the vast majority of vim's +community will be covered. + +[libuv]: https://github.com/joyent/libuv -##### New plugin architecture +### New plugin architecture -All code supporting embedded scripting language interpreters will be replaced by a new plugin system that will support extensions written in any programming language. +All code supporting embedded scripting language interpreters will be replaced by +a new plugin system that will support extensions written in any programming +language. -Compatibility layers will be provided for vim plugins written in some of the currently supported scripting languages such as python or ruby. Most plugins should work on neovim with little modifications, if any. +Compatibility layers will be provided for vim plugins written in some of the +currently supported scripting languages such as Python or Ruby. Most plugins +should work on neovim with little modifications, if any. This is how the new plugin system will work: -- Plugins are long-running programs/jobs (coprocesses) that communicate with vim through stdin/stdout using msgpack-rpc or json-rpc. -- Vim will discover and run these programs at startup, keeping two-way communication channels with each plugin through its lifetime. -- Plugins will be able to listen to events and send commands to vim asynchronously. +- Plugins are long-running programs/jobs (coprocesses) that communicate with vim + through stdin/stdout using msgpack-rpc or json-rpc. +- Vim will discover and run these programs at startup, keeping two-way + communication channels with each plugin through its lifetime. +- Plugins will be able to listen to events and send commands to vim + asynchronously. -This system will be built on top of a job control mechanism similar to the one implemented by the [job control patch](https://groups.google.com/forum/#!topic/vim_dev/QF7Bzh1YABU) +This system will be built on top of a job control mechanism similar to the one +implemented by the [job control patch][]. -Here's an idea of how a plugin session might work using [json-rpc](http://www.jsonrpc.org/specification) (jsonrpc version omitted): +Here's an idea of how a plugin session might work using [json-rpc][] (json-rpc version omitted): ```js plugin -> neovim: {"id": 1, "method": "listenEvent", "params": {"eventName": "keyPressed"}} @@ -86,33 +133,47 @@ plugin -> neovim: {"id": 2, "method": "showPopup", "params": {"size": {"width": plugin -> neovim: {"id": 2, "result": true}} ``` -That shows an hypothetical conversation between neovim and completion plugin that displays completions when the user presses Ctrl+Space. The above scheme gives neovim near limitless extensibility and also improves stability as plugins will automatically be isolated from the main executable. +That shows a hypothetical conversation between neovim and a completion plugin +which displays completions when the user presses Ctrl+Space. The above scheme +gives neovim near limitless extensibility and also improves stability as plugins +will be automatically isolated from the main executable. -This system can also easily emulate the current scripting languages interfaces to vim. For example, a plugin can emulate the python interface by running python scripts sent by vim in its own context and by exposing a 'vim' module with an API matching the current one. Calls to the API would simply be translated to json-rpc messages sent to vim. +This system can also easily emulate the current scripting language interfaces +to vim. For example, a plugin can emulate the Python interface by running +Python scripts sent by vim in its own context and by exposing a `vim` module +with an API matching the current one. Calls to the API would simply be +translated to json-rpc messages sent to vim. +[job control patch]: https://groups.google.com/forum/#!topic/vim_dev/QF7Bzh1YABU +[json-rpc]: http://www.jsonrpc.org/specification -##### New GUI architecture +### New GUI architecture -Another contributing factor to vim's huge codebase is the explicit support for dozens of widget toolkits for GUI interfaces. Like the legacy code support, gui-specific code will be removed. +Another contributing factor to vim's huge codebase is the explicit support for +dozens of widget toolkits for GUI interfaces. Like the legacy code support, +GUI-specific code will be removed. Neovim will handle GUIs similarly to how it will handle plugins: - GUIs are separate programs, possibly written in different programming languages. -- Neovim will use its own stdin/stdout to receive input and send updates, again using json-rpc or msgpack-rpc. +- Neovim will use its own stdin/stdout to receive input and send updates, again + using json-rpc or msgpack-rpc. -The difference between plugins and GUIs is that plugins will be started by neovim, where neovim will be started by programs running the GUI. Here's a sample diagram of the process tree: +The difference between plugins and GUIs is that plugins will be started by +neovim, whereas neovim will be started by programs running the GUI. Here's a +sample diagram of the process tree: ``` GUI program | - ---> Neovim + `--> Neovim | - ---> Plugin 1 + `--> Plugin 1 | - ---> Plugin 2 + `--> Plugin 2 | - ---> Plugin 3 + `--> Plugin 3 ``` Hypothetical GUI session: @@ -127,56 +188,73 @@ vim -> gui: {"method": "redraw", "params": {"clientId": 1, "lines": {"1": "Hello This new GUI architecture creates many interesting possibilities: -- Modern GUIs written in high-level programming languages that integrate better with the operating system. We can have GUIs written using C#/WPF on Windows or Ruby/Cocoa on Mac, for example. -- Plugins will be able to emit custom events that may be handled directly by GUIs. This will enable the implementation of advanced features such as sublime's minimap. -- A multiplexing daemon could keep neovim instances running in a headless server, while multiple remote GUIs could attach/detach to share editing sessions. +- Modern GUIs written in high-level programming languages that integrate better + with the operating system. We can have GUIs written using C#/WPF on Windows + or Ruby/Cocoa on OS X, for example. +- Plugins will be able to emit custom events that may be handled directly by + GUIs. This will enable the implementation of advanced features such as + Sublime's minimap. +- A multiplexing daemon could keep neovim instances running in a headless + server, while multiple remote GUIs could attach/detach to share editing + sessions. - Simplified headless testing. -- Embedding the editor into other programs. In fact, a GUI can be seen as a program that embeds neovim. +- Embedding the editor into other programs. In fact, a GUI can be seen as a + program that embeds neovim. Here's a diagram that illustrates how a client-server process tree might look like: ``` Server daemon listening on tcp sockets <------ GUI 1 (attach/detach to running instances using tcp sockets) | | - ---> Neovim | + `--> Neovim | | GUI 2 (sharing the same session with GUI 1) - ---> Plugin 1 + `--> Plugin 1 | - ---> Plugin 2 + `--> Plugin 2 | - ---> Plugin 3 + `--> Plugin 3 ``` -##### Development on Github +### Development on GitHub -Development will happen on the [github organization](https://github.com/neovim), and the code will be split across many repositories, unlike the current vim source tree. +Development will happen in the [GitHub organization][], and the code will be +split across many repositories, unlike the current vim source tree. -There will be separate repositories for GUIs, plugins, runtime files (official vimscript) and distributions. This will let the editor receive improvements much faster as the patches don't have to go all through a single person for approval. +There will be separate repositories for GUIs, plugins, runtime files (official +vimscript) and distributions. This will let the editor receive improvements much +faster, as the patches don't have to go all through a single person for approval. -Travis will also be used for continuous integration, so pull requests will be automatically checked. +Travis will also be used for continuous integration, so pull requests will be +automatically checked. + +[GitHub organization]: https://github.com/neovim ### Status Here's a list of things that have been done so far: - Source tree was cleaned up, leaving only files necessary for compilation/testing of the core. -- Source files were processed with [unifdef](http://freecode.com/projects/unifdef) to remove tons of FEAT_* macros -- Files were processed with [uncrustify](http://uncrustify.sourceforge.net/) to normalize source code formatting. -- The autotools build system was replaced by [cmake](http://www.cmake.org/) +- Source files were processed with [unifdef][] to remove tons of `FEAT_*` macros. +- Files were processed with [uncrustify][] to normalize source code formatting. +- The autotools build system was replaced by [CMake][]. and what is currently being worked on: -- Port all IO to libuv +- Porting all IO to libuv. -###Dependencies +[unifdef]: http://freecode.com/projects/unifdef +[uncrustify]: http://uncrustify.sourceforge.net/ +[CMake]: http://cmake.org/ -For Ubuntu 12.04: +### Dependencies + +#### Ubuntu 12.04 sudo apt-get install build-essential cmake libncurses5-dev -For OsX: +#### OS X * Install [Xcode](https://developer.apple.com/) * Install sha1sum @@ -189,12 +267,12 @@ For OsX: brew install md5sha1sum cmake libtool -TODO: release the Dockerfile which has this in it - -TODO: Arch instructions +#### TODO +* Release the Dockerfile which has this in it. +* Write instructions for Arch Linux. -###Building +### Building To generate the `Makefile`s: @@ -206,4 +284,4 @@ To build and run the tests: ### Community -Join the community on IRC in #neovim on Freenode. +Join the community on IRC in #neovim on freenode.