diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 13 insertions, 17 deletions
@@ -33,9 +33,10 @@ Features -------- - Modern [GUIs](https://github.com/neovim/neovim/wiki/Related-projects#gui) -- [API](https://github.com/neovim/neovim/wiki/Related-projects#api-clients) - access from any language including Clojure, Lisp, Go, Haskell, Lua, - JavaScript, Perl, Python, Ruby, and Rust +- [API access](https://github.com/neovim/neovim/wiki/Related-projects#api-clients) + from any language including C/C++, C#, Clojure, D, Elixir, Lisp, Go, + Haskell, Java, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, + Ruby, Rust - Embedded, scriptable [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html) - Asynchronous [job control](https://github.com/neovim/neovim/pull/2247) - [Shared data (shada)](https://github.com/neovim/neovim/pull/2506) among multiple editor instances @@ -56,19 +57,21 @@ and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)! Install from source ------------------- +The build is CMake-based, but a Makefile is provided as a convenience. + make CMAKE_BUILD_TYPE=RelWithDebInfo sudo make install -To install to a non-default location, set `CMAKE_INSTALL_PREFIX`: +To install to a non-default location: - make CMAKE_EXTRA_FLAGS="-DCMAKE_INSTALL_PREFIX=/full/path/" + make CMAKE_INSTALL_PREFIX=/full/path/ make install To skip bundled (`third-party/*`) dependencies: 1. Install the dependencies using a package manager. ``` - sudo apt install gperf luajit luarocks libuv1-dev libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libjemalloc-dev + sudo apt install gperf luajit luarocks libuv1-dev libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev sudo luarocks build mpack sudo luarocks build lpeg sudo luarocks build inspect @@ -79,17 +82,10 @@ To skip bundled (`third-party/*`) dependencies: sudo make install ``` -CMake features: - -- List all build targets: - ``` - cmake --build build --target help - ``` -- Print all variable definitions: - ``` - cmake -LAH - ``` -- `build/CMakeCache.txt` contains the resolved values of all CMake variables. +To inspect the build, these CMake features are useful: + +- `cmake --build build --target help` lists all build targets. +- `build/CMakeCache.txt` (or `cmake -LAH build/`) contains the resolved values of all CMake variables. - `build/compile_commands.json` shows the full compiler invocations for each translation unit. See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details. |