diff options
| author | Patrick Spek <p.spek@tyil.nl> | 2019-11-01 11:48:30 +0100 |
|---|---|---|
| committer | Patrick Spek <p.spek@tyil.nl> | 2019-11-01 11:48:30 +0100 |
| commit | e0416bf1a9bf810e2ca1591b88c9fc4508fd33c5 (patch) | |
| tree | fccccf94dc4d52b586200bb779f5ecae7a13f842 /README.md | |
| parent | 0e92a12c3429afec0f2c4787c2ed14e9cce961cd (diff) | |
Update release documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 20 insertions, 16 deletions
@@ -1,25 +1,29 @@ # Rakudo Star -This git repository contains _only_ the tools needed to create a Rakudo Star distribution. +Rakudo Star is a user-oriented distribution of the Raku programming language, +and a number of common community modules. -The `tar` files available from `github.com` -are NOT suitable for building Rakudo Star; do not use them. +This git repository contains _only_ the tools needed to create a Rakudo Star +distribution, not the sources of individual components of the distribution. +These are fetched when you build the distribution tarball. -## Get Rakudo Star -To get the latest release of Rakudo Star, please download the corresponding file depending on your platform. +The `tar` files available from `github.com` for MoarVM, NQP and Rakudo are NOT +suitable for building Rakudo Star; do not use them. Instead, use the tarballs +found on the individual projects' sites, which correctly contain all the +utilities and dependencies used by them. -* [Linux](https://rakudo.org/latest/star/source) -* [Windows](https://rakudo.org/latest/star/win64) -* [macOS](https://rakudo.org/latest/star/macos) +## Get Rakudo Star -## Build Rakudo Star -If you're a Rakudo Star release manager, or someone who wants to create a new Perl 6 -distribution based on the tools here, then run `make -f tools/star/Makefile` to -populate a distribution image. +To get the latest release of Rakudo Star, please download the corresponding +file depending on your platform. -## Guides -* [Release guide](tools/star/release-guide.pod) +- [Linux](https://rakudo.org/latest/star/source) +- [Windows](https://rakudo.org/latest/star/win64) +- [macOS](https://rakudo.org/latest/star/macos) -* [Guide to build MSI packages](tools/star/windows-msi.pod) +## Build Rakudo Star -* [Guide to build DMG packages](tools/star/mac-dmg.pod) +If you're a Rakudo Star release manager, or someone who wants to create a +user-friendly Raku distribution based on the tools here, check the `guides` +directory. This contains documentation on how to make a Rakudo Star tarball, as +well as information on how to create Windows `.msi` and MacOS `.dmg` packages. |