From 4de98bde53324e1b6f29af91323bed3b550d9468 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Dom=C3=ADnguez?= Date: Sat, 26 May 2018 18:14:58 +0000 Subject: [PATCH 1/2] Move to markdown extension --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 8ac448d3495cc022566fb8213c2f5b38185573c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Dom=C3=ADnguez?= Date: Sat, 26 May 2018 18:19:52 +0000 Subject: [PATCH 2/2] README: Some markdown format tweaks --- README.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d126c8ef..6e304cca 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,19 @@ Sysprof is a sampling profiler that uses a kernel module to generate stacktraces which are then interpreted by the userspace program "sysprof". -See the Sysprof homepage: - - http://sysprof.com/ - -for more information +See the [Sysprof homepage](http://sysprof.com/) for more information. Questions, patches and bug reports should be sent to the sysprof -mailing list: +mailing list [sysprof-list@gnome.org](mailto:sysprof-list@gnome.org). - sysprof-list@gnome.org - -The list is archived here: - - https://mail.gnome.org/archives/sysprof-list/ +The list is archived in . Debugging symbols +----------------- -- The programs and libraries you want to profile should be compiled - with -fno-omit-frame-pointer and have debugging symbols available, - or you won't get much usable information. +The programs and libraries you want to profile should be compiled +with `-fno-omit-frame-pointer` and have debugging symbols available, +or you won't get much usable information. Building Sysprof @@ -39,7 +32,7 @@ Then do the following: ninja sudo ninja install -WARNING: `ninja install` will mostly install under the configured install +**WARNING**: `ninja install` will mostly install under the configured install prefix but installs systemd service configuration directly in the system default location `/usr/lib/systemd` so it won't work without root privileges, even if the install prefix is a user-owned directory.