aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2018-12-09 01:49:59 +0100
committerJustin M. Keyes <justinkz@gmail.com>2018-12-30 21:09:39 +0100
commit4ba8266ab1212a9c1e3250f3785061ee8d52043e (patch)
treeb10464193dafe59d919eb9791fe1c70e9b429c8b /README.md
parentfa5182489a660e672bac6ea78ba4eefcbba9d6eb (diff)
downloadrneovim-4ba8266ab1212a9c1e3250f3785061ee8d52043e.tar.gz
rneovim-4ba8266ab1212a9c1e3250f3785061ee8d52043e.tar.bz2
rneovim-4ba8266ab1212a9c1e3250f3785061ee8d52043e.zip
doc
- CMake features
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 36 insertions, 17 deletions
diff --git a/README.md b/README.md
index 0aa77b1e68..39d809002e 100644
--- a/README.md
+++ b/README.md
@@ -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
--------------------