aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNat Lasseter <nat.lasseter@york.ac.uk>2020-11-16 12:27:20 +0000
committerNat Lasseter <nat.lasseter@york.ac.uk>2020-11-16 12:27:20 +0000
commitaa4ababb52cba98eb27e8d67460db8dc610d475a (patch)
tree48619d652e87c82847b26eea1691cdea86e3849c
parent96b8a92fc11d094eedc24bf9b3f76a230d654416 (diff)
Add mention of examples to ReadmeHEADmaster
-rw-r--r--Readme.textile4
1 files changed, 3 insertions, 1 deletions
diff --git a/Readme.textile b/Readme.textile
index 8744307..8559de9 100644
--- a/Readme.textile
+++ b/Readme.textile
@@ -43,6 +43,8 @@ Raiders go out, raid things, and return to the longboat with metrics for the col
Longboat will pick up all raiders in the @lib/raiders@ directory by default.
+There are some example raiders in @examples@.
+
h3. Raider structure
Each raider consists of:
@@ -101,4 +103,4 @@ The <code>@my_config</code> hash will look like:
bc. {:myraider_an_argument => true, :myraider_an_argument_given => true}
-Be aware that there's no namespacing between raider arguments, so it's recommended that you prefix your argument with the raider's name, such as @--myraider-an-argument@. Also be aware that the automatic short-options are very likely to clash horribly, so try to avoid using these. Finally There is presently no way to get help about raider arguments.
+Be aware that there's no namespacing between raider arguments, so it's recommended that you prefix your argument with the raider's name, such as @--myraider-an-argument@. Also be aware that the automatic short-options are very likely to clash horribly, so try to avoid using these. Finally, there is presently no way to get help about raider arguments.