Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed Dec 9, 2018
1 parent a64fddf commit 462a7be
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Cpuusage
|-----------------|
| [![Build status](https://travis-ci.org/d99kris/cpuusage.svg?branch=master)](https://travis-ci.org/d99kris/cpuusage) |

Cpuusage is an instrumentation CPU profiler for Linux applications.
Cpuusage is an instrumentation CPU profiler for Linux and macOS applications.
It provides logging of standard POSIX function calls for any application, and logging of
internal function calls for programs compiled with -finstrument-functions.
The logging output format is a HTML-file generated using
Expand All @@ -28,7 +28,8 @@ Resulting visualization:

Supported Platforms
===================
Cpuusage is primarily developed and tested on Linux.
Cpuusage is primarily developed and tested on Linux, but basic functionality
should work in macOS / OS X as well.

Installation
============
Expand Down Expand Up @@ -147,10 +148,11 @@ Resulting visualization:

Alternatives
============
There are many CPU profilers available for Linux. Most of them are sample-based, and here
is a list of some of them:
There are many CPU profilers available for Linux and macOS. Most of them are
sample-based, and here is a list of some of them:
- Gperftools
- Gprof
- Instruments - Time Profiler
- Valgrind - Callgrind

License
Expand All @@ -159,5 +161,5 @@ Cpuusage is distributed under the BSD 3-Clause license. See LICENSE file.

Keywords
========
linux, cpu usage, instrumented profiler, alternative to callgrind.
linux, macos, cpu usage, instrumented profiler, alternative to callgrind.

0 comments on commit 462a7be

Please sign in to comment.