Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #1

Merged
merged 1 commit into from
Nov 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) API
==================================================================================

This ITT/JIT open source profiling API includes:

- Instrumentation and Tracing Technology (ITT) API
- Just-In-Time (JIT) Profiling API

The Instrumentation and Tracing Technology (ITT) API enables your application
to generate and control the collection of trace data during its execution
across different Intel tools.

ITT API consists of two parts: a _static part_ and a _dynamic part_. The
_dynamic part_ is specific for a tool and distributed only with a particular
tool. The _static part_ is a common part shared between tools. Currently, the
static part of ITT API is distributed as a static library and released under
a BSD/GPLv2 dual license with every tool supporting ITT API.

### Build

To build the library:
- On Windows, Linux and OSX: requires [cmake](https://cmake.org) to be set in `PATH`
- Run `python buildall.py`
- Windows: requires Visual Studio installed or requires [Ninja](https://github.com/ninja-build/ninja/releases) to be set in `PATH`

### Run

To load the library:
- On Windows and Linux: Set environment variable `INTEL_LIBITTNOTIFY32`/`INTEL_LIBITTNOTIFY64` to the full path pointing to `libittnotify[32/64].[lib/a]`
- On OSX: Set environment variable `DYLD_INSERT_LIBRARIES` to the full path to `libittnotify.dylib`
28 changes: 0 additions & 28 deletions README.txt

This file was deleted.