Fixing some typos and making it easier to read.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@xxxxxxxxx>
---
README | 32 +++++++++++++++++---------------
1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/README b/README
index f5035f9..b1934c3 100644
--- a/README
+++ b/README
@@ -7,7 +7,8 @@ The official repository is here:
Third Party Software:
------------------------------------------------------------
KernelShark has the following external dependencies:
- Cmake, Json-C, OpenGL/Glut, Qt5Base, libtraceevent, libtracefs, trace-cmd.
+ Cmake, Json-C, OpenGL/Glut, Qt5Base, libtraceevent, libtracefs, trace-cmd
+ and FreeSans font.
1. In order to install the packages on Ubuntu do the following:
sudo apt-get install build-essential git cmake libjson-c-dev -y
@@ -15,7 +16,7 @@ KernelShark has the following external dependencies:
sudo apt-get install fonts-freefont-ttf
sudo apt-get install qtbase5-dev -y
-1.1 I you want to be able to generate Doxygen documentation:
+1.1 If you want to be able to generate Doxygen documentation:
sudo apt-get install graphviz doxygen-gui -y
@@ -24,7 +25,7 @@ KernelShark has the following external dependencies:
dnf install freeglut-devel redhat-rpm-config -y
dnf install qt5-qtbase-devel -y
-2.1 I you want to be able to generate Doxygen documentation:
+2.1 If you want to be able to generate Doxygen documentation:
dnf install graphviz doxygen -y
@@ -46,26 +47,27 @@ KernelShark has the following external dependencies:
Building:
------------------------------------------------------------
-2. Building KernelShark:
+1. Building and install KernelShark GUI:
cd kernel-shark/build
cmake ../
make
sudo ./install_gui.sh
-2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
-as a CMake Command-Line option.
+1.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
+as a CMake Command-Line option (see the example below).
-2.2 KernelShark has multiple build types. By default, the build type is
+1.2 KernelShark has multiple build types. By default, the build type is
RelWithDebInfo, which will build a release candidate with debug information.
-To change the type, pass in the option CMAKE_BUILD_TYPE=<type>.
+To change the type, pass in the option CMAKE_BUILD_TYPE=<type> (see the
+example below).
cmake -DCMAKE_BUILD_TYPE=Debug - for "-g" option
cmake -DCMAKE_BUILD_TYPE=Release - for "-O3" option
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo - for "-g -O2" option (default)
cmake -DCMAKE_BUILD_TYPE=MinSizeRel - for "-Os" option
-2.3 In addition to the standard CMake build types (Debug, Release,
+1.3 In addition to the standard CMake build types (Debug, Release,
RelWithDebInfo, MinSizeRel) KernelShark supports a "Package" build type.
By default this build type adds the "-O3" compiler flag. Package maintainers
can chose their own compiler flags by providing the corresponding
@@ -74,19 +76,19 @@ CMAKE_XXXX_FLAGS_PACKAGE Command-Line options (see the example below).
-- Note that when built as a "Package" the RPATH-s of the executables are
set directly to _INSTALL_PREFIX/lib/kernelshark/
-2.4 After building the code "kernel-shark/lib" will contain all libraries
+1.4 After building the code "kernel-shark/lib" will contain all libraries
and "kernel-shark/bin" will contain all executables.
-2.5 Use the script "cmake_clean.sh" if you want to delete all already
+1.5 Use the script "cmake_clean.sh" if you want to delete all already
compiled objects and all files generated by CMake.
cd kernel-shark/build
- ./cmake-clean.sh
+ ./cmake_clean.sh
-2.6 By default, installation prefix is "/usr/local". It can be changed using
--D_INSTALL_PREFIX= as a CMake Command-Line option.
+1.6 By default, installation prefix is "/usr/local". It can be changed using
+-D_INSTALL_PREFIX= as a CMake Command-Line option (see the example below).
-2.7 In order to uninstall KernelShark do:
+1.7 In order to uninstall KernelShark do:
cd kernel-shark/build
./cmake_uninstall.sh
--
2.27.0
|