Browse Source

README.md: improve markup

master
Matteo Cypriani 2 years ago
parent
commit
150a89bb40
1 changed files with 13 additions and 14 deletions
  1. 13
    14
      README.md

+ 13
- 14
README.md View File

@@ -1,4 +1,4 @@
1
-pstack - print stack trace of running processes
1
+# pstack - print stack trace of running processes
2 2
 
3 3
 pstack dumps a stack trace for a process, given the pid of that
4 4
 process.  If the process named is part of a thread group, then all the threads
@@ -6,8 +6,9 @@ inthe group are traced.  See the man page for more information.
6 6
 
7 7
 This program was inspired by the 'pstack' program available on Solaris.
8 8
 
9
-SUPPORTED PLATFORMS:
10
-	This program runs on 32 bit x86 machines, using ELF binaries
9
+## Supported Platforms
10
+
11
+This program runs on 32 bit x86 machines, using ELF binaries
11 12
 generated from GNU compilers.  If threads are being used, it depends
12 13
 on a debuggable version of the pthreads library to find the threads in
13 14
 the thread group.  If anyone wants to port this to other
@@ -15,22 +16,20 @@ architectures, please let me know about questions you may have, or
15 16
 achievements you have made.  I'd like to incorporate such changes into
16 17
 my version of the code.
17 18
 
18
-FEATURES:
19
-	symbolic address dumping
20
-  thread group support
19
+## Features
21 20
 
22
-BUILD:
23
-   make
21
+* symbolic address dumping
22
+* thread group support
24 23
 
25
-INSTALL:
26
-	 make install
24
+## Build, install, uninstall
27 25
 
28
-UNINSTALL:
29
-   make uninstall
26
+    make
27
+    make install
28
+    make uninstall
30 29
 
31
-NOTE: you must be root to [un]install.  pstack will run fine from any
30
+**Note:** you must be root to [un]install. pstack will run fine from any
32 31
 directory, install just puts the binary and man page in 'normal'
33
-places (/usr/local/...)
32
+places (`/usr/local/...`)
34 33
 
35 34
 USAGE:
36 35
 	pstack pid [...]

Loading…
Cancel
Save