From 7f576c74d60e12677194e68f821f9da2cbb5f223 Mon Sep 17 00:00:00 2001 From: David Chisnall Date: Mon, 25 Feb 2019 13:18:50 +0000 Subject: [PATCH] Update docs to mention macOS. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 13cfb75..1028bf8 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ build configuration. Alternatively, you can follow the steps in the next section to build with Ninja using the Visual Studio compiler. -# Building on Linux or FreeBSD +# Building on macOS, Linux or FreeBSD Snmalloc has very few dependencies, CMake, Ninja, Clang 6.0 or later and a C++17 standard library. Building with GCC is currently not supported because GCC lacks support for the @@ -61,7 +61,8 @@ cmake -G Ninja .. -DCMAKE_BUILD_TYPE=RelWithDebInfo ninja ``` -The build produces a binary `libsnmallocshim.so`. This file can be +On ELF platforms, The build produces a binary `libsnmallocshim.so`. +This file can be `LD_PRELOAD`ed to use the allocator in place of the system allocator, for example, you can run the build script using the snmalloc as the allocator for your toolchain: