README.md
1# The SkyPat Team
2
3-----------------------------------------------------------------------------
4
5## Introduction
6 "SkyPat" is a C++ performance analyzing and testing framework on Android and
7 Linux platforms. It combines perf_events and unit tests together and gives
8 programmers the power of fine-grained performance analysis via writing
9 typical test cases.
10
11## Latest release
12
13* v3.1.1 Bourbon
14 - Tarball: https://github.com/skymizer/SkyPat/archive/v3.1.1.tar.gz
15 - Zipball: https://github.com/skymizer/SkyPat/archive/v3.1.1.zip
16
17## Directory Structure
18
19```
20share/SkyPat/README - this document
21share/SkyPat/LICENSE - the License
22share/SkyPat/examples/ - the place of examples
23include/ - include file, exported interface
24lib/ - libraries of exported interface
25```
26
27## Supported platforms
28
29SkyPat supports macOS, Ubuntu/x86_64, Debian/arm, Fedora/x86_64, Fedora/arm,
30 and CentOS/x86_64.
31
32Here is a list of verified versions:
33
34* Ubuntu/x86_64
35 - 14.04 and later versions
36* Fedora/x86_64
37 - 20 and later versions
38* CentOS/x86_64
39 - 7 and later versions
40* Debian/arm
41 - 8.6 and later versions
42
43## Getting Started
44
45## Download and build SkyPat
46
47
48You could download **SkyPat** either from the latest release tar-ball or from
49 our `git` repository.
50
51### Method 1: Download **SkyPat** from the latest release tar-ball
52Download the source code from the latest release tar-ball.
53
54 $ wget -O SkyPat-3.1.1.tar.gz https://github.com/skymizer/SkyPat/archive/v3.1.1.tar.gz
55 $ tar zxvf SkyPat-3.1.1.tar.gz
56
57### Method 2: Download **SkyPat** from our `git` repository
58Download the source code from our `git` repository into ${SKYPAT_SRC} directory.
59
60 $ git clone https://github.com/skymizer/SkyPat.git ${SKYPAT_SRC}
61
62### Install required packages
63
64#### Ubuntu/Debian users
65
66Install following packages before you install **SkyPat**.
67
68 $ sudo apt-get install wget automake autoconf libtool build-essential
69
70#### Fedora/CentOS users
71
72Install following packages before you install **SkyPat**.
73
74 $ sudo yum install wget automake autoconf libtool make automake gcc gcc-c++
75 $ sudo yum install kernel-devel
76
77### Build by Auto-tools
78
79If there are no `configure` shell script in the directory,
80 use `./autogen.sh` to generate `configure` script.
81
82 $ ./autogen.sh
83
84Use `./configure` to configure the package for your system.
85See [INSTALL](https://github.com/skymizer/SkyPat/blob/master/INSTALL INSTALL) for
86more details.
87
88 $ ./configure --prefix=${SKYPAT_INSTALL}
89
90Use `make` to compile the package
91
92 $ make
93
94Type `make install` to install the package into your system.
95
96 $ make install
97
98### Run Examples
99
100Examples of **SkyPat** are installed at ${SKYPAT_INSTALL}/share/skypat/examples.
101You can go to any sub-directory and build it. For example:
102
103 cd ${SKYPAT_INSTALL}/share/skypat/examples/assertion
104 make
105
106Then, if **SkyPat** is successfully installed, you should see:
107
108 c++ -I../../../../include -L../../../../lib main.cpp my_case.cpp -lskypat -o assertion
109 LD_LIBRARY_PATH=../../../../lib ./assertion
110 [ SkyPat ] Running 2 tests from 1 cases.
111 [----------] 2 tests from MyCase.
112 [ RUN ] MyCase.fibonacci_test
113 [ OK ]
114 [ RUN ] MyCase.factorial_test
115 [ OK ]
116 [==========] 2 tests from 1 cases ran.
117 [ PASSED ] 2 tests.
118
119## User Guide
120
121For those who need more information about **SkyPat**, please check out our
122 [UserGuide](https://github.com/skymizer/SkyPat/wiki/HowToUse) on Github.
123