Insert recommendations for make html and making docs

Since Defn is only interpreted after 2018.11, that's been the version recommended. It should work with prior versions, only they will not be rendered in the same way. Closes #2424
Raku · Dec 8, 2018 · e3fb0e6 · e3fb0e6
1 parent ce78069
commit e3fb0e6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -235,6 +235,8 @@ You need Perl 6 installed. You can install the Rakudo Perl 6 compiler by
 downloading the latest Rakudo Star release from
 [rakudo.org/downloads/star/](http://rakudo.org/downloads/star/).
 
+> For best results, you will need to install one of the latest versions, > 2018.11 if possible. It's not guaranteed to work with other versions, and in any case the produced documentation will not look the same.
+
 #### Zef
 
 [Zef](https://modules.perl6.org/repo/zef) is a Perl 6 module installer. If you

diff --git a/README.md b/README.md
@@ -71,6 +71,9 @@ To build the documentation web pages, simply run:
 
     $ make html
 
+> For best results, we recommend that you use the latest released versions, specially any one after 2018.11.
+
+
 Please note that you will need to have [nodejs](https://nodejs.org)
 installed to produce HTML content with the above command, in particular
 a `node` executable should be in your `PATH`. Besides, you will need