aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSeongJae Park <sj38.park@gmail.com>2024-03-16 11:43:11 -0700
committerSeongJae Park <sj38.park@gmail.com>2024-03-16 11:43:11 -0700
commit379269a402a9aff25a254e2bbc615b4015ce1300 (patch)
tree89a2af3d61e8d6f0851c4e8e0604f39e8ddcd77d
parent44b2f77275dd0bf02110c0eb91c0e5e4df6eee4a (diff)
downloaddamo-379269a402a9aff25a254e2bbc615b4015ce1300.tar.gz
README: Put major features introductions into one section
Signed-off-by: SeongJae Park <sj38.park@gmail.com>
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index 480900d9..e16485df 100644
--- a/README.md
+++ b/README.md
@@ -90,8 +90,15 @@ notice and grace periods. The documented features could also be deprecated,
but those will provide some notification and grace periods.
+Quick Intro for Major Features
+==============================
+
+Below are quick introductions for `damo`'s major features.
+For more detailed usage, please refer to [USAGE.md](USAGE.md) file.
+
+
Snapshot Data Access Pattern
-============================
+----------------------------
Below commands repeatedly get a snapshot of the access pattern of a program for
every second.
@@ -112,7 +119,7 @@ every second and show on terminal.
Recording Data Access Patterns
-==============================
+------------------------------
Below commands record memory access patterns of a program and save the
monitoring results in `damon.data` file.
@@ -129,7 +136,7 @@ workload. The last line asks ``damo`` to record the access pattern in
Visualizing Recorded Patterns
-=============================
+-----------------------------
Below three commands visualize the recorded access patterns into three
image files.
@@ -155,7 +162,7 @@ workloads are also available [2,3,4].
Data Access Pattern Aware Memory Management
-===========================================
+-------------------------------------------
Below command makes every memory region of size >=4K that hasn't accessed for
>=60 seconds in your workload to be swapped out. By doing this, you can make