Skip to content

Commit

Permalink
Adds explanation of where binaries should go
Browse files Browse the repository at this point in the history
Closes Raku#3999
  • Loading branch information
JJ committed Mar 26, 2022
1 parent cdcfb34 commit 646dab9
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/Language/modules.pod6
Original file line number Diff line number Diff line change
Expand Up @@ -704,6 +704,8 @@ Vortex-TotalPerspective/
β”œβ”€β”€ LICENSE
β”œβ”€β”€ META6.json
β”œβ”€β”€ README.md
└── bin
β”‚ └── vortex
└── t
└── basic.t
=end code
Expand Down Expand Up @@ -754,7 +756,15 @@ my $template-text = %?RESOURCES<templates/default-template.mustache>.slurp;
=end item
=item The C<README.md> file is a L<markdown-formatted|https://help.github.com/articles/markdown-basics/>
=item Programs and scripts that you need in the C<$PATH> for execution need
to be
included in the C<bin> directory; these will be copied to whatever directory
your installed Rakudo distribution has allotted for executables; could be
something like C<~/.rakubrew/shims/> (if you use the excellent
C<App::Rakubrew> for them)
=item The C<README.md> file is a
L<markdown-formatted|https://help.github.com/articles/markdown-basics/>
text file, which will later be automatically rendered as HTML by GitHub/GitLab for modules kept
in those ecosystems or by L<modules.raku.org|https://modules.raku.org> website for modules
kept on L<CPAN|/language/faq#index-entry-CPAN_(FAQ)>.
Expand Down

0 comments on commit 646dab9

Please sign in to comment.