Skip to content

Update README.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2022
Merged

Update README.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

```
Expand Down Expand Up @@ -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.
Open `build/dokka/html/index.html` to view generated documentation.