diff --git a/README.md b/README.md index 393797ef..4b91638a 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,12 @@ The Slick/Simple Debugger Ensure you have the following dependencies: * Python 3.6 or newer +* [libkdumpfile](https://github.com/ptesarik/libkdumpfile) (optional - needed for kdump-compressed crash dumps) * [drgn](https://github.com/osandov/drgn/) -Then run: +Note that in order for `drgn` to support kdump files it needs to be *compiled* with `libkdumpfile`. Unfortunately that means that users should always install `libkdumpfile` first before installing `drgn`. + +Finally run the following to install `sdb`: ``` $ git clone https://github.com/delphix/sdb.git $ cd sdb @@ -17,3 +20,7 @@ $ sudo python3 setup.py install ``` The above should install `sdb` under `/usr/local/bin/`. + +### Resources + +User and developer resources for sdb can be found in the [project's wiki](https://github.com/delphix/sdb/wiki).