doc: README improvements
This commit is contained in:
parent
4daef05550
commit
4468aa0ee1
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
|
@ -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
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue