summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Bütow <pbuetow@mimecast.com>2018-12-27 07:21:37 +0000
committerPaul Bütow <pbuetow@mimecast.com>2018-12-27 07:21:37 +0000
commit9fe9a107718c80a67e2a4018b0d49ad35e195ade (patch)
tree84b42fff6ec00565e238a70613184a0c2b30b139
parentf30db3239fdb0c134b76ef75e780bf014b4a0342 (diff)
add info of tested docker platform
-rw-r--r--README.md4
-rw-r--r--docs/markdown/installation.md2
2 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3851a3d..d39ed58 100644
--- a/README.md
+++ b/README.md
@@ -47,11 +47,11 @@ This is also potentially a great tool just for analysing (not replaying) the I/O
Future work will also include file hole support and I/O support for memory mapped files.
-# Installation
+# How to install I/O Riot
I/O Riot depends on SystemTap and a compatible version of the Linux Kernel. To get started have a read through the [installation guide](docs/markdown/installation.md).
-# Operating I/O Riot
+# How to use I/O Riot
Check out the [I/O Riot usage guide](docs/markdown/usage.md) for a full usage workflow demonstration.
diff --git a/docs/markdown/installation.md b/docs/markdown/installation.md
index 2fdc98f..6eb9346 100644
--- a/docs/markdown/installation.md
+++ b/docs/markdown/installation.md
@@ -48,3 +48,5 @@ make dockerbuild
That will run for quite a while (depending on the download speed it can take more than 15 minutes!). Afterwards distribute directory ``./docker/opt/ioriot`` to ``/opt/ioriot`` to all boxes with that particular running kernel version.
By repeating the steps above it is possible to compile the SystemTap Kernel modules for multiple versions. All the modules will be found seamlessly in ``./docker/opt/ioriot/systemtap``.
+
+Docker build support has been tested on macOS X High Sierra and Docker Desktop CE Version 2.0.0.0-mac81 and will work very likely on all other systems with a Docker up and running.