Skip to content

Commit a7716fc

Browse files
committed
Clarify deps installation instructions
Per discussion[^1], revert previous commit[^2] and clarify how to get rakudobrew going The Right Way™ by updating the shim with `rehash` command. [1] 1b3cf97#commitcomment-19334016 [2] 1b3cf97
1 parent 1b3cf97 commit a7716fc

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,24 @@ to see the documentation for method `split` in class `Str`.
2121

2222
## Building the HTML documentation
2323

24-
To build the documentation web pages, simply run
24+
Install dependencies by running the following in the checkout directory:
2525

26-
$ make html
26+
panda installdeps . # if you use panda
27+
zef --depsonly install . # if you use zef
28+
29+
If you use [`rakudobrew`](https://github.com/tadzik/rakudobrew), also run the
30+
following, to update the shims for installed executables:
31+
32+
rakudobrew rehash
2733

28-
In addition to the Perl 6 dependencies, you need to have `graphviz` installed.
34+
In addition to the Perl 6 dependencies, you need to have `graphviz` installed, which
35+
on Debian you can do by running
2936

30-
Also install Pod::To::BigPage i.e. panda install Pod::To::BigPage then copy ~/.rakudobrew/moar-nom/install/share/perl6/site/bin/pod2onepage to ~/.rakudobrew/bin/
37+
sudo apt-get install graphviz
38+
39+
To build the documentation web pages, simply run
40+
41+
$ make html
3142

3243
After the pages have been generated, you can view them on your local
3344
computer by starting the included `app.pl` program:

0 commit comments

Comments
 (0)