From 1356a175a7c9a022a45df198e976d94dc53a38a6 Mon Sep 17 00:00:00 2001
From: onefang
Date: Tue, 25 Jun 2019 15:15:33 +1000
Subject: Add actual markdown.

---
 README.md | 48 ++++++++++++++++++++++++++++++++++--------------
 1 file changed, 34 insertions(+), 14 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 415025c..4217dc0 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,9 @@ will be maintained.  Currently the shell scripts and Python scripts are
 actually being used I think.  Evilham asked me to write this, after I
 badgered him about his Python scripts.
 
-The source code is at https://sledjhamr.org/cgit/mirror-checker-lua/
+The source code is at [https://sledjhamr.org/cgit/mirror-checker-lua/]
 
-The issue tracker is at https://sledjhamr.org/mantisbt/project_page.php?project_id=13
+The issue tracker is at [https://sledjhamr.org/mantisbt/project_page.php?project_id=13]
 
 
 Installation.
@@ -51,45 +51,65 @@ the easy to read emails (once I write that bit).
 Note that unlike typical commands, you can't run single character options
 together, so this is wrong -
 
-./mirror-checker.lua -vvv
+```Shell Session
+$ ./mirror-checker.lua -vvv
+```
 
 Instead do this -
 
-./mirror-checker.lua -v -v -v
+```Shell Session
+$ ./mirror-checker.lua -v -v -v
+```
 
 Just run the script to do all of the tests -
 
-./mirror-checker.lua
+```Shell Session
+$ ./mirror-checker.lua
+```
 
 Which will print any errors.  If you don't want to see errors -
 
-./mirror-checker.lua -q
+```Shell Session
+$ ./mirror-checker.lua -q
+```
 
 If you want to see warnings to (as usual, the more -v options, the more
 details) -
 
-./mirror-checker.lua -v
+```Shell Session
+$ ./mirror-checker.lua -v
+```
 
 Or use the usual options for the help and version number -
 
-./mirror-checker.lua -h 
-./mirror-checker.lua --help
-./mirror-checker.lua --version
+```Shell Session
+$ ./mirror-checker.lua -h 
+$ ./mirror-checker.lua --help
+$ ./mirror-checker.lua --version
+```
 
 To run the tests on a specific mirror, for example pkgmaster.devuan.org -
 
-./mirror-checker.lua pkgmaster.devuan.org
+```Shell Session
+$ ./mirror-checker.lua pkgmaster.devuan.org
+```
 
 You can use the --tests option to tune which tests are run, for example
 to stop IPv6 tests, coz you don't have IPv6 -
 
-./mirror-checker.lua --tests=-IPv6
+```Shell Session
+$ ./mirror-checker.lua --tests=-IPv6
+```
 
 To do the same, but not run the HTTPS tests either -
 
-./mirror-checker.lua --tests=-IPv6,-https
+```Shell Session
+$ ./mirror-checker.lua --tests=-IPv6,-https
+```
 
 To only run the http integrity tests, only on IPv6 -
 
-./mirror-checker.lua --tests=http,Integrity,IPv6
+```Shell Session
+$ ./mirror-checker.lua --tests=http,Integrity,IPv6
+```
 
-- 
cgit v1.1