diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2018-12-30 21:17:18 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-30 21:17:18 +0100 |
| commit | 1e8d2bdc487cdebf152eb228ed936720cfed3a76 (patch) | |
| tree | f4933a9250ac93d6dd6998b9bafb87bb1beae8ab /README.md | |
| parent | fa5182489a660e672bac6ea78ba4eefcbba9d6eb (diff) | |
| parent | a10fdc70aa1e7e48421a473a2fab49b79089426c (diff) | |
| download | rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.gz rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.bz2 rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.zip | |
Merge #9335 from justinmk/doc
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 53 |
1 files changed, 36 insertions, 17 deletions
@@ -44,6 +44,15 @@ Features See [`:help nvim-features`][nvim-features] for the full list! +Install from package +-------------------- + +Pre-built packages for Windows, macOS, and Linux are found on the +[Releases](https://github.com/neovim/neovim/releases/) page. + +Managed packages are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Gentoo], +and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)! + Install from source ------------------- @@ -55,26 +64,36 @@ To install to a non-default location, set `CMAKE_INSTALL_PREFIX`: make CMAKE_EXTRA_FLAGS="-DCMAKE_INSTALL_PREFIX=/full/path/" make install -To list all targets: - - cmake --build build --target help - -To skip "bundled" dependencies (`third-party/*`) define `USE_BUNDLED=NO`: - - sudo apt install gperf libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libjemalloc-dev - make USE_BUNDLED=NO +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 luarocks build mpack + sudo luarocks build lpeg + sudo luarocks build inspect + ``` +2. Build with `USE_BUNDLED=OFF`: + ``` + make CMAKE_BUILD_TYPE=RelWithDebInfo USE_BUNDLED=OFF + 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. +- `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. -Install from package --------------------- - -Pre-built packages for Windows, macOS, and Linux are found on the -[Releases](https://github.com/neovim/neovim/releases/) page. - -Managed packages are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Gentoo], -and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)! - Transitioning from Vim -------------------- |