doc: README improvements

This commit is contained in:
Roland Conybeare 2023-10-17 15:06:30 -04:00
commit 4468aa0ee1

View file

@ -1,6 +1,12 @@
# pybind11 utilities for XO projects # 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 $ cd xo-pyutil
@ -11,3 +17,9 @@ $ cmake -DCMAKE_MODULE_PATH=${PREFIX}/share/cmake -DCMAKE_PREFIX_PATH=$(PREFIX)
$ make $ make
$ make install $ 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
```