Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
First pass at Perl 6 -> Raku
  • Loading branch information
coke committed Aug 13, 2019
1 parent 4f06cce commit 7bef410
Show file tree
Hide file tree
Showing 30 changed files with 516 additions and 516 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Expand Up @@ -43,7 +43,7 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
* Please use the present tense unless writing about history or upcoming events or planned features
* Prefer [active voice](https://en.wikipedia.org/wiki/Active_voice) to the [passive voice](https://en.wikipedia.org/Passive_voice#In_English) with "by": "this is used by crafty programmers" → "crafty programmers use this"
* Link to external resources (like Wikipedia) for topics that are not
directly related to Perl 6 (like the math that our routines implement).
directly related to Raku (like the math that our routines implement).
* Duplicate small pieces of information rather than rely on linking.
* Be explicit about routine signatures. If a method accepts an `*%args`,
but treats some of them specially, list them separately.
Expand Down Expand Up @@ -94,11 +94,11 @@ questions come up in the process feel free to ask in
If the documentation for a type does not exist, create the skeleton of the doc
with the helper tool `util/new-type.p6`. Say you want to create `MyFunnyRole`:

$ perl6 util/new-type.p6 --kind=role MyFunnyRole
$ raku util/new-type.p6 --kind=role MyFunnyRole

Fill the documentation file `doc/Type/MyFunnyRole.pod6` like this:

```perl6
```raku
=TITLE role MyFunnyRole
=SUBTITLE Sentence or half-sentence about what it does
Expand Down Expand Up @@ -130,7 +130,7 @@ comment `Z<>`.

When providing a code example result or output, use this style:

```perl6
```raku
# For the result of an expression.
1 + 2; # RESULT: «3»
# For the output.
Expand Down Expand Up @@ -216,9 +216,9 @@ Assuming that you have already forked and cloned the
you probably want to do is to build the documentation on your local
computer. To do this you will need:

- Perl 6 (e.g., the Rakudo Perl 6 implementation)
- zef (the installer for third party Perl 6 modules)
- `Pod::To::HTML` (Perl 6 module for converting Pod 6 objects to HTML)
- Raku (e.g., the Rakudo Raku implementation)
- zef (the installer for third party Raku modules)
- `Pod::To::HTML` (Raku module for converting Pod 6 objects to HTML)
- [graphviz](http://www.graphviz.org/) (`sudo apt-get install graphviz` on Debian/Ubuntu)
- [Mojolicious](https://metacpan.org/pod/Mojolicious)
(optional; a Perl 5 web framework; it allows you to run a web
Expand All @@ -235,15 +235,15 @@ computer. To do this you will need:

#### Rakudo

You need Perl 6 installed. You can install the Rakudo Perl 6 compiler by
You need Raku installed. You can install the Rakudo Raku 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
[Zef](https://modules.perl6.org/repo/zef) is a Raku module installer. If you
installed Rakudo Star package, it should already be there. Feel free to
use any other module installer for the modules needed (see below).

Expand Down
2 changes: 1 addition & 1 deletion CREDITS
Expand Up @@ -251,7 +251,7 @@ E: patch@cpan.org

N: Patrick R. Michaud
U: pmichaud
D: Perl 6 (Rakudo Perl) lead developer, pumpking
D: Raku (Rakudo Perl) lead developer, pumpking
E: pmichaud@pobox.com

N: Paul Cochrane
Expand Down
4 changes: 2 additions & 2 deletions META6.json
@@ -1,6 +1,6 @@
{
"name": "p6doc",
"description": "Perl 6 documentation (tools and docs)",
"description": "Raku documentation (tools and docs)",
"version": "1.003",
"perl": "6.*",
"authors": [
Expand Down Expand Up @@ -43,4 +43,4 @@
],
"source-url": "git://github.com/perl6/doc.git",
"meta6": "0"
}
}
2 changes: 1 addition & 1 deletion README.md
@@ -1,4 +1,4 @@
# Official Documentation of Perl 6
# Official Documentation of Raku

[![Build Status](https://travis-ci.org/perl6/doc.svg?branch=master)](https://travis-ci.org/perl6/doc) [![artistic](https://img.shields.io/badge/license-Artistic%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Artistic-2.0) [![Run Status](https://api.shippable.com/projects/591e99923f2f790700098a30/badge?branch=master)](https://app.shippable.com/github/perl6/doc)

Expand Down

0 comments on commit 7bef410

Please sign in to comment.