[PATCH 2/3] trace-cruncher: Update README.md

From: "Yordan Karadzhov (VMware)" <y.karadz@gmail.com>
To: linux-trace-devel@vger.kernel.org
Cc: "Yordan Karadzhov (VMware)" <y.karadz@gmail.com>
Subject: [PATCH 2/3] trace-cruncher: Update README.md
Date: Wed, 25 Aug 2021 12:44:35 +0300	[thread overview]
Message-ID: <20210825094436.46958-2-y.karadz@gmail.com> (raw)
In-Reply-To: <20210825094436.46958-1-y.karadz@gmail.com>

Improve the the description of the project and make the provided
information consistent with content of CONTRIBUTING.md.

Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 README.md | 31 +++++++++++++------------------
 1 file changed, 13 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 9a3696c..93f12c8 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 is 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.
 
-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.
+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 [libtraceevent](https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git), [libtracefs](https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/) and [KernelShark](https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git/) projects and is build on top of the C API of this librearies.
 
 ## Try it out
 
@@ -23,13 +23,17 @@ Trace-Cruncher has the following external dependencies:
 
     > sudo apt-get install libpython3-dev cython3 python3-numpy python3-pip -y
 
+    > sudo apt-get install flex valgrind -y
+
     > sudo pip3 install --system pkgconfig GitPython
 
 1.2 In order to install all packages on Fedora, as root do the following:
 
-    > dnf install gcc gcc-c++ git cmake json-c-devel -y
+    > sudo dnf install gcc gcc-c++ git cmake json-c-devel -y
+
+    > sudo dnf install python3-devel python3-Cython python3-numpy python3-pip -y
 
-    > dnf install python3-devel python3-Cython python3-numpy python3-pip -y
+    > sudo dnf install flex valgrind -y
 
     > sudo pip3 install --system pkgconfig GitPython
 
@@ -58,17 +62,6 @@ Trace-Cruncher has the following external dependencies:
     > cd ..
 
 
-    > git clone https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
-
-    > cd trace-cmd
-
-    > make
-
-    > sudo make install_libs
-
-    > cd ..
-
-
     > git clone https://github.com/yordan-karadzhov/kernel-shark-v2.beta.git kernel-shark
 
     > cd kernel-shark/build
@@ -92,14 +85,16 @@ Installing trace-cruncher is very simple. After downloading the source code, you
      > sudo make install
 
 ## Documentation
+For questions about the use of Trace-Cruncher, please send email to: linux-trace-users@vger.kernel.org
 
-For bug reports and issues, please file it here:
+[Subscribe](http://vger.kernel.org/vger-lists.html#linux-trace-users) / [Archives](https://lore.kernel.org/linux-trace-users/)
 
-https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---
+For bug reports and issues, please file it
+[bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)
 
 ## Contributing
 
-The trace-cruncher project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
+The trace-cruncher project team welcomes contributions from the community. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
-- 
2.30.2

