diff --git a/README.md b/README.md index a3f0e06..12a1748 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,15 @@ The C++17 version of NanoLog works like a traditional library; just [``#include To build the C++17 NanoLog Runtime library, go in the [runtime directory](./runtime/) and invoke ```make```. This will produce ```./libNanoLog.a``` to against link your application and a ```./decompressor``` application that can be used to re-inflate the binary logs. +```bash +git clone https://github.com/PlatformLab/NanoLog.git +cd Nanolog +git submodule update --init +cd runtime +make -j6 +make DESTDIR=/usr/local/ install +``` + When you compile your application, be sure to include the NanoLog header directory ([``-I ./runtime``](./runtime/)), and link against NanoLog, pthreads, and POSIX AIO (``-L ./runtime/ -lNanoLog -lrt -pthread``). Sample g++ invocations can be found in the [sample GNUmakefile](./sample/GNUmakefile). After you compile and run the application, the log file generated can then be passed to the ```./decompressor``` application to generate the full human-readable log file (instructions below).