Adds pointer in README.md

And removes example to the former examples dir to the new one. Refs #49
Raku · Dec 8, 2018 · f5ea68c · f5ea68c
1 parent 901c9b8
commit f5ea68c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -65,7 +65,6 @@ say pod2html $=pod[0], :templates("lib/templates");
 
 
 ```
-
 ## DESCRIPTION
 
 `Pod::To::HTML` takes a Pod 6 tree and outputs correspondingly
@@ -79,6 +78,9 @@ Optionally, a custom header/fooder/head-fields can be
 provided. These can be used to link to custom CSS stylesheets and
 JavaScript libraries.
 
+## Examples
+
+Check the [`examples`](resources/examples/README.md) directory (which should have been installed with your distribution, or is right here if you download from source) for a few illustrative examples.
 
 ## DEBUGGING
 

diff --git a/examples/01-parse-files.p6 → resources/examples/01-parse-files.p6 b/examples/01-parse-files.p6 → resources/examples/01-parse-files.p6
diff --git a/resources/examples/README.md b/resources/examples/README.md
@@ -0,0 +1,13 @@
+# Some examples for the module.
+
+Test
+
+	perl6 -I../../lib render.p6
+
+which uses the local [template `main.mustache`](main.mustache) instead of the default one. Add a pod6 or pm6 file at the end if you want to check a different file. 
+
+Change to the upper dir, and run
+
+	perl6 -Ilib resources/examples/01-parse-files.p6
+
+for a similar version which uses the same file.