diff --git a/README.md b/README.md index 69de713..a99b8f1 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,26 @@ An embedded key-value store for modern SSDs. ## Building from source + +### Install Dependencies + +A few packages that Treeline depends on are + +- `libtbb-dev` +- `autoconf` +- `libjemalloc-dev` + +Depending on the distribution you have, ensure the above packages are installed. +On Ubuntu, you can install the dependencies using `apt`: + +``` +sudo apt install libtbb-dev autoconf libjemalloc-dev +``` + +TreeLine's other dependencies are fetched by CMake during compilation. + +### Compile + CMake 3.17+ is required for building this project. ```bash