Skip to content

Commit 010a004

Browse files
committed
Update README
1 parent d82a303 commit 010a004

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# A memory profiler for Linux
1+
# Bytehound - a memory profiler for Linux
22

33
## Features
44

@@ -18,6 +18,9 @@
1818
* Can dynamically stream the profiling data to another machine instead
1919
of saving it locally, which is useful for profiling on memory-constrained systems
2020
* Supports AMD64, ARM, AArch64 and MIPS64 architectures (where MIPS64 requires a tiny out-of-tree kernel patch for `perf_event_open`)
21+
* Supports profiling of applications which use jemalloc as their allocator (only works on AMD64 with the `jemallocator` crate)
22+
* Supports an embedded DSL based on [Rhai](https://rhai.rs) to allow for programmatic
23+
and/or automated data analysis
2124

2225
[Heaptrack GUI]: https://github.com/KDE/heaptrack
2326

@@ -59,6 +62,10 @@
5962

6063
Then open your Web browser and point it at `http://localhost:8080` to access the GUI.
6164

65+
## Documentation
66+
67+
You can find the full documentation for the profiler in our [Memory profiling for fun and profit](https://koute.github.io/bytehound/) book.
68+
6269
## Enabling full debug logs
6370

6471
By default the profiler is compiled with most of its debug logs disabled for performance reasons.

0 commit comments

Comments
 (0)