roland/xo-tokenizer2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document compile_commands.json symlink + .gitignore

Browse source
This commit is contained in:
Roland Conybeare 2023-10-06 17:05:08 -04:00
commit c8280cb8c4
2 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -2,3 +2,5 @@
.cache
# typical cmake build directory (source-tree-nephew)
build*/*
# symlink to builddir/compile_commands.json; should be set manually in dev sandbox
compile_commands.json

9
README.md
View file

@ -5,6 +5,7 @@
$ cd reflect
$ mkdir build
$ cd build
$ INSTALL_PREFIX=/usr/local # or wherever you prefer
$ cmake -DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} ..
$ make
$ make install
@ -12,8 +13,14 @@ $ make install
### build for unit test coverage
```
$ cd refcnt
$ cd xo-reflect
$ mkdir build-ccov
$ cd build-ccov
$ cmake -DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} -DCODE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug ..
```
### LSP support
```
$ cd xo-reflect
$ ln -s build/compile_commands.json # lsp will look for compile_commands.json in the root of the source tree
```