[v2,10/12] trace-cruncher: Update README.md
diff mbox series

Message ID 20200107170312.27116-11-y.karadz@gmail.com
State New, archived
Headers show
Series
  • Build trace-cruncher as Python pakage
Related show

Commit Message

Yordan Karadzhov (VMware) Jan. 7, 2020, 5:03 p.m. UTC
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 README.md | 50 +++++++++++---------------------------------------
 1 file changed, 11 insertions(+), 39 deletions(-)

Patch
diff mbox series

diff --git a/README.md b/README.md
index c5121ab..2f7d533 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@ 
 
 ## Overview
 
-The Trace-Cruncher project aims to provide an interface between the existing instrumentation for collection and visualization of tracing data from the Linux kernel and the broad and very well developed ecosystem of instruments for data analysis available in Python. The interface will be based on NumPy.
+The Trace-Cruncher project aims to provide an interface between the existing instrumentation for collection and visualization of tracing data from the Linux kernel and the broad and very well developed ecosystem of instruments for data analysis available in Python. The interface is based on NumPy.
 
-NumPy implements an efficient multi-dimensional container of generic data and uses strong typing in order to provide fast data processing in Python. The  Trace-Cruncher will allow for sophisticated analysis of kernel tracing data via scripts, but it will also opens the door for exposing the kernel tracing data to the instruments provided by the scientific toolkit of Python like MatPlotLib, Stats, Scikit-Learn and even to the nowadays most popular frameworks for Machine Learning like TensorFlow and PyTorch. The Trace-Cruncher is strongly coupled to the KernelShark project and is build on top of the C API of libkshark.
+NumPy implements an efficient multi-dimensional container of generic data and uses strong typing in order to provide fast data processing in Python. The  Trace-Cruncher allows for sophisticated analysis of kernel tracing data via scripts, but it also opens the door for exposing the kernel tracing data to the instruments provided by the scientific toolkit of Python like MatPlotLib, Stats, Scikit-Learn and even to the nowadays most popular frameworks for Machine Learning like TensorFlow and PyTorch. The Trace-Cruncher is strongly coupled to the KernelShark project and is build on top of the C API of libkshark.
 
 ## Try it out
 
@@ -17,55 +17,27 @@  Trace-Cruncher has the following external dependencies:
 
 1.1 In order to install the packages on Ubuntu do the following:
 
-    sudo apt-get install libjson-c-dev libpython3-dev cython3 -y
+    > sudo apt-get install libjson-c-dev libpython3-dev cython3 -y
 
-    sudo apt-get install python3-numpy python3-matplotlib -y
+    > sudo apt-get install python3-numpy python3-matplotlib -y
 
 1.2 In order to install the packages on Fedora, as root do the following:
 
-    dnf install json-c-devel python3-devel python3-Cython -y
+    > dnf install json-c-devel python3-devel python3-Cython -y
 
-    dnf install python3-numpy python3-matplotlib -y
-
-2. In order to get the proper version of KernelShark / trace-cmd do the
-following:
-
-    git clone git://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git --branch=kernelshark-v1.1
-
-or download a tarball from here:
-https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/snapshot/trace-cmd-kernelshark-v1.1.tar.gz
+    > dnf install python3-numpy python3-matplotlib -y
 
 ### Build & Run
 
-1. Patch trace-cmd / KernelShark:
-
-    cd path/to/trace-cmd/
-
-    git am ../path/to/trace-cruncher/0001-kernel-shark-Add-_DEVEL-build-flag.patch
-
-    git am ../path/to/trace-cruncher/0002-kernel-shark-Add-reg_pid-plugin.patch
-
-2. Install trace-cmd:
-
-    make
-
-    sudo make install_libs
-
-3. Install KernelShark:
-
-    cd kernel-shark/build
-
-    cmake -D_DEVEL=1 ../
-
-    make
+Installing trace-cruncher is very simple. After downloading the source code, you just have to run:
 
-    sudo make install
+     > cd trace-cruncher
 
-4. Build the NumPy API itself:
+     > make
 
-    cd path/to/trace-cruncher
+     > sudo make install
 
-    ./np_setup.py build_ext -i
+Note that this will automatically download, patch and build the appropriate versions of "trace-cmd / KernelShark" libraries from kernel.org. These third-party libraries will be installed as part of trace-cruncher itself and will not interfere with any existing system-wide installations of trace-cmd and KernelShark.
 
 ## Documentation