doc: README additions

This commit is contained in:
Roland Conybeare 2023-10-17 15:30:13 -04:00
commit 2de57c1ec3

View file

@ -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