Skip to content

hankache/rakuguide

Repository files navigation

Raku Guide

This document is intended to give you a quick overview of the Raku programming language.
For those who are new to Raku it should get you up and running.

Website

For online reading navigate to:

Building the document

The document is written in asciidoc format and generated using asciidoctor and pygments. You will need a current version of ruby, asciidoctor, pygments, and a special gem that provides a pre-release version of asciidoctor-pdf.

Install the required tools:

$ sudo pip install Pygments
$ sudo gem install asciidoctor
$ sudo gem install asciidoctor-pdf
$ sudo gem install pygments.rb

To produce rakuguide.pdf, run:

$ asciidoctor-pdf rakuguide.adoc

To produce rakuguide.html, run:

$ asciidoctor rakuguide.adoc

Feedback

All feedback is welcomed:

  • Corrections
  • Suggestions
  • Additions
  • Translations

Translations

If you wish to translate this document, always use the English version as your starting point. If you are starting a new translation create a new file. For example, the French translation will be in fr.rakuguide.adoc, the Deutsch translation in de.rakuguide.adoc
If you want to modify a translated version, consider modifying the English version first. It is important that all translations be kept in sync.

Currently the translations are in different phases of completion. For completeness rely on the English version.

Contributing

Kindly prefix your commit title with the language it is targeting. For example, all commits targeting the English version would have a title that starts with [EN]. All commits targeting the Spanish translation have a title that starts with [ES].

Authors

For the full list of contributors: https://github.com/hankache/rakuguide/graphs/contributors

License

Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/.