doc: README additions

This commit is contained in:
Roland Conybeare 2023-10-17 15:21:24 -04:00
commit add1004108
2 changed files with 12 additions and 4 deletions

View file

@ -25,7 +25,7 @@ add_code_coverage()
add_code_coverage_all_targets(EXCLUDE /nix/store/* ${PROJECT_SOURCE_DIR}/utest/* ${PROJECT_BINARY_DIR}/local/* ${PROJECT_SOURCE_DIR}/repo/*)
# ----------------------------------------------------------------
# c++ settings
# common c++ settings
# PROJECT_CXX_FLAGS: bespoke for this project - usually empty
set(PROJECT_CXX_FLAGS "")

View file

@ -5,7 +5,14 @@ Reentrant:
even while being invoked.
2. Any such re-entrant operations are deferred until callback invocation completes.
# build + install
## Getting Started
### build + install dependencies
- [github/Rconybea/refcnt](https://github.com/Rconybea/refcnt)
### build + install
```
$ cd xo-callback
$ mkdir build
@ -20,7 +27,8 @@ $ make install
```
(also see .github/workflows/main.yml)
# build for unit test coverage
### build for unit test coverage
```
$ cd xo-callback
$ mkdir build-ccov
@ -32,7 +40,7 @@ $ cmake \
-DCMAKE_BUILD_TYPE=Debug ..
```
# LSP (language server) support
### LSP (language server) support
LSP looks for compile commands in the root of the source tree;
cmake creates them in the root of its build directory.