More markdown markup in README.md
authorJohan Tibell <johan.tibell@gmail.com>
Fri, 8 Feb 2013 21:17:25 +0000 (13:17 -0800)
committerJohan Tibell <johan.tibell@gmail.com>
Fri, 8 Feb 2013 21:17:25 +0000 (13:17 -0800)
README.md

index 99e2a6f..78fe1c7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,24 +15,24 @@ system GHC:
 
 Then, to run the tests, execute:
 
-  $ make clean
-  $ make boot
-  $ make 2>&1 | tee nofib-log
+    make clean
+    make boot
+    make 2>&1 | tee nofib-log
 
-This will put the results in the file 'nofib-log'. You can pass extra
-options to a nofib run using the EXTRA_HC_OPTS variable like this:
+This will put the results in the file `nofib-log`. You can pass extra
+options to a nofib run using the `EXTRA_HC_OPTS` variable like this:
 
-  $ make clean
-  $ make boot
-  $ make EXTRA_HC_OPTS="-fllvm" >&1 | tee nofib-llvm-log
+    make clean
+    make boot
+    make EXTRA_HC_OPTS="-fllvm" >&1 | tee nofib-llvm-log
 
 To compare the results of multiple runs, use the program in
-../utils/nofib-analyse, for example:
+`../utils/nofib-analyse`, for example:
 
-  $ nofib-analyse nofib-log-6.4.2 nofib-log-6.6
+    nofib-analyse nofib-log-6.4.2 nofib-log-6.6
 
-to generate a comparison of the runs in captured in 'nofib-log-6.4.2'
-and 'nofib-log-6.6'. When making comparisons, be careful to ensure
+to generate a comparison of the runs in captured in `nofib-log-6.4.2`
+and `nofib-log-6.6`. When making comparisons, be careful to ensure
 that the things that changed between the builds are only the things
 that you _wanted_ to change. There are lots of variables: machine,
 GHC version, GCC version, C libraries, static vs. dynamic GMP library,
@@ -42,13 +42,13 @@ side, make both runs on the same unloaded machine.
 ## Configuration
 
 There are some options you might want to tweak; search for nofib in
-../mk/config.mk, and override settings in ../mk/build.mk as usual.
+`../mk/config.mk`, and override settings in `../mk/build.mk` as usual.
 
 ## Extra Metrics: Valgrind
 
 To get instruction counts, memory reads/writes, and "cache misses",
-you'll need to get hold of Cachegrind, which is part of Valgrind
-(http://valgrind.org).
+you'll need to get hold of Cachegrind, which is part of
+[Valgrind](http://valgrind.org).
 
 ## Extra Packages