[sysprof: 2/3] README: Some markdown format tweaks



commit 8ac448d3495cc022566fb8213c2f5b38185573c3
Author: Alejandro Domínguez <adomu posteo net>
Date:   Sat May 26 18:19:52 2018 +0000

    README: Some markdown format tweaks

 README.md | 23 ++++++++---------------
 1 file changed, 8 insertions(+), 15 deletions(-)
---
diff --git a/README.md b/README.md
index d126c8e..6e304cc 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:
-
-        sysprof-list gnome org
-
-The list is archived here:
+mailing list [sysprof-list gnome org](mailto:sysprof-list gnome org).
 
-        https://mail.gnome.org/archives/sysprof-list/
+The list is archived in <https://mail.gnome.org/archives/sysprof-list/>.
 
 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.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]