From ed5408877858827763279bdb0c36f4b11b376c24 Mon Sep 17 00:00:00 2001 From: Aaron Riekenberg Date: Mon, 9 May 2022 09:32:17 -0500 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 50b5baa..8b1908a 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This project provides the following components: * Advantages of this design: * All allocate, resize, and free operations after startup are very fast because they do not do native-memory allocation or free operations - * Fragmentation is not an issue because OffHeapMemoryBuffer has no requirement for memory pages to be contiguous + * Fragmentation is not an issue because NativeMemoryBuffer has no requirement for memory pages to be contiguous * Buffer * Supports OnHeapMemoryBuffer as a normal on-heap byte array * Supports NativeMemoryBuffer as a list of native memory pages allocated by NativeMemoryAllocator @@ -37,6 +37,12 @@ See the `examples` directory for complete runnable example applications. Basic steps to use NativeMemoryAllocator: +Add the following repository to maven or gradle build: +``` +https://maven.pkg.github.com/target/native_memory_allocator +``` +Add `com.target:native_memory_allocator` dependency to maven or gradle build - see [releases page](https://github.com/target/native_memory_allocator/packages/1407699) for current version. + Define a map value object. ``` @@ -125,4 +131,4 @@ To generate HTML documentation use the following command: ./gradlew -PdokkaEnabled=true dokkaHtml ``` -Open `build/dokka/html/index.html` to view generated documentation. \ No newline at end of file +Open `build/dokka/html/index.html` to view generated documentation.