Skip to content

Commit 9379274

Browse files
committed
Document how to run examples in README
1 parent 73832bb commit 9379274

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ on Rakudo, it should end in .rakudo.
1111
If you want to contribute, just ask! The quicker choice is to use IRC: join
1212
#perl6 in Freenode and you'll be welcome.
1313

14-
1514
Please use POD (mostly this template
1615
https://github.com/perl6/perl6-examples/blob/master/template_pod) when
1716
adding a new example.
@@ -22,10 +21,8 @@ adding a new example.
2221
2. Help different implementations of Perl 6 test out their code in a less
2322
testy and more fun manner `;)`
2423

25-
2624
## What you can find here
2725

28-
2926
| Directory | Description |
3027
|--------------------|------------------------------------------|
3128
|best-of-rosettacode | The best of the rosettacode.org examples |
@@ -50,6 +47,21 @@ Since you have a commit-bit (if not then talk to the folks at #perl6 on
5047
irc.freenode.net) feel free to commit your changes to the main repository.
5148
No need to submit a pull request!
5249

50+
## Running the examples
51+
52+
To run most examples (all examples excluding those which take a very long
53+
time or are memory hogs) one can use the `run-examples.pl` script in the
54+
`bin` directory:
55+
56+
$ perl6 bin/run-examples.pl
57+
58+
If one wishes to run the examples for a given category, then one can simply
59+
use the `--category=<category-dir>` option specifying the desired category's
60+
directory name. For example, to run the examples for the `cookbook`
61+
category, use the following:
62+
63+
$ perl6 bin/run-examples.pl --category=cookbook
64+
5365
## Building the examples documentation
5466

5567
To build the examples documentation web pages, simply run the `htmlify.p6`

0 commit comments

Comments
 (0)