From add10041086a807c9c984f3e0506b2aaaf20584f Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Tue, 17 Oct 2023 15:21:24 -0400 Subject: [PATCH] doc: README additions --- CMakeLists.txt | 2 +- README.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5b0079d4..d67984af 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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 "") diff --git a/README.md b/README.md index fcfa8e8a..53cc5849 100644 --- a/README.md +++ b/README.md @@ -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.