From 4468aa0ee173b482c48b0bac3656cc49ef14ff9c Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Tue, 17 Oct 2023 15:06:30 -0400 Subject: [PATCH] doc: README improvements --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9bbae3..3aa5ee8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # pybind11 utilities for XO projects -# to build + install locally +## Getting Started + +### build + install dependencies + +- see [github/Rconybea/xo-cmake](https://github.com/Rconybea/xo-cmake) + +### to build + install locally ``` $ cd xo-pyutil @@ -11,3 +17,9 @@ $ cmake -DCMAKE_MODULE_PATH=${PREFIX}/share/cmake -DCMAKE_PREFIX_PATH=$(PREFIX) $ make $ make install ``` + +### LSP support +``` +$ cd xo-pyutil +$ ln -s build/compile_commands.json # lsp will look for compile_commands.json in the root of the source tree +```