aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2023-02-12 17:47:01 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2023-02-12 17:47:01 -0500
commitee0ed5e1087c8e9eea91caea6e82435475c05071 (patch)
tree68d0f867680b12d0a25913e1f9c3975cfc01ba13 /README.md
parentf32a27234bde14394797b0bc70ba98fccdce0ec4 (diff)
downloadmstat-ee0ed5e1087c8e9eea91caea6e82435475c05071.tar.gz
Add brief installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0fe45b5..e6d79d7 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,22 @@
Record the memory usage of a process over time.
+## Installation
+
+- **Requires**
+ - Linux
+ - `make`
+ - `cmake` (>= v3.x)
+ - `gcc` or `clang` (C99 compiler)
+ - `gnuplot` (optional)
+
+```shell
+git clone https://github.com/jhunkeler/mstat && cd mstat
+cmake -DCMAKE_INSTALL_PREFIX=/usr/local .
+make
+make install
+```
+
# How to use MSTAT
```text