From 2de57c1ec3643544d40b0781e29eeba3c74e32de Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Tue, 17 Oct 2023 15:30:13 -0400 Subject: [PATCH] doc: README additions --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a8eb8c77..34463fb0 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ # webutil library (header-only) -# dependencies +## Getting Started -- xo-cmake [github/Rconybea/xo-cmake](https://github.com/Rconybea/xo-cmake) +### build + install dependencies + +- xo-callback [github/Rconybea/xo-callback](https://github.com/Rconybea/xo-callback) + +### clone repo -# clone repo ``` $ git clone git@github.com:Rconybea/xo-webutil.git ``` -# build and install +### build and install + ``` $ cd xo-webutil $ BUILDDIR=build # for example @@ -21,7 +25,8 @@ $ make $ make install ``` -# LSP support +### LSP support + ``` $ cd xo-webutil $ ln -s $BUILDDIR/compile_commands.json