Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Paolo Di Tommaso <[email protected]>
  • Loading branch information
pditommaso committed Aug 21, 2024
1 parent 5b08799 commit 598f0d7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

# Ignore Gradle build output directory
build
app/out/
out/
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,25 @@ The goal of this project is being able to track usage of off-heap memory and det
The detection is made via a Java agent implemented by using [Byte Buddy](https://bytebuddy.net/) library.


### Get started
### Get started

1. Create the agent jar file using this command:

```
./gradlew jar
```
`

2. Launch the agent along with your Java application by adding these options
to the Java command line:

```
-javaagent:$PWD/build/libs/unsafe-tracker-<VERSION>.jar \
-Xbootclasspath/a:$PWD/build/libs/unsafe-tracker-<VERSION>.jar \`
```


### Development

1. Compile the project using this command

Expand All @@ -21,3 +39,8 @@ The detection is made via a Java agent implemented by using [Byte Buddy](https:/
```
bash run.sh
```


### Credits

Thanks to Rafael Winterhalter for advising about the use of the [Byte Buddy](https://github.com/raphw/byte-buddy).

0 comments on commit 598f0d7

Please sign in to comment.