From bc55885778898247204a3b2392ace02de95e24a2 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Tue, 17 Oct 2023 15:13:58 -0400 Subject: [PATCH] doc: README additions --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 434a80a5..7be07dd9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # python bindings for c++ reflection library (xo-reflect) -## build + install +## Getting Started + +### build + install dependencies + +- [github/Rconybea/xo-pyutil](https://github.com/Rconybea/xo-pyutil) +- [github/Rconybea/xo-reflect](https://github.com/Rconybea/xo-reflect) + +### build + install ``` $ cd xo-pyreflect $ mkdir build @@ -13,8 +20,9 @@ $ cmake \ $ make $ make install ``` +(also see .github/workflows/main.yml) -## build for unit test coverage +### build for unit test coverage ``` $ cd xo-pyreflect $ mkdir build-ccov @@ -26,7 +34,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; while Cmake creates them in the root of its build directory.