aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAliaksey Kandratsenka <alkondratenko@gmail.com>2016-02-29 20:09:39 -0800
committerAliaksey Kandratsenka <alkondratenko@gmail.com>2016-02-29 20:09:39 -0800
commit66e1e94f38467b5c7bbfb05e3c7267f3039a2c69 (patch)
tree2ad9df02381064de3a1b253d496c366e52802e7e
parent2804b7cfee8d49d5ab98340cbf3050c0a5f57b98 (diff)
downloadgperftools-66e1e94f38467b5c7bbfb05e3c7267f3039a2c69.tar.gz
added minimal "header section" to README
-rw-r--r--README26
1 files changed, 22 insertions, 4 deletions
diff --git a/README b/README
index bffc617..6b99ea8 100644
--- a/README
+++ b/README
@@ -1,7 +1,25 @@
-IMPORTANT NOTE FOR 64-BIT USERS
--------------------------------
-There are known issues with some perftools functionality on x86_64
-systems. See 64-BIT ISSUES, below.
+gperftools
+----------
+(originally Google Performance Tools)
+
+The fastest malloc we’ve seen; works particularly well with threads
+and STL. Also: thread-friendly heap-checker, heap-profiler, and
+cpu-profiler.
+
+
+OVERVIEW
+---------
+
+gperftools is a collection of a high-performance multi-threaded
+malloc() implementation, plus some pretty nifty performance analysis
+tools.
+
+gperftools is distributed under the terms of the BSD License. Join our
+mailing list at gpeftools@googlegroups.com for updates.
+
+gperftools was original home for pprof program. But do note that
+original pprof (which is still included with gerftools) is now
+deprecated in favor of golang version at https://github.com/google/pprof
TCMALLOC