diff options
author | pmichaud <pmichaud@pobox.com> | 2010-08-05 09:54:48 -0500 |
---|---|---|
committer | pmichaud <pmichaud@pobox.com> | 2010-08-05 09:54:48 -0500 |
commit | 6b6a829bb825bc7962ee01196ad2ac08c793fff8 (patch) | |
tree | bd5ad18e3a8a5d159df744262202abea5d23a010 | |
parent | 18d8ab8a12249f6824802600ec2ea77bd4255263 (diff) |
Update the README.
-rw-r--r-- | README | 26 |
1 files changed, 15 insertions, 11 deletions
@@ -1,16 +1,18 @@ -Rakudo Star -- a Perl 6 distribution based on Rakudo Perl +Rakudo Star -- a useful, usable, "early adopter" distribution of Perl 6 -See <http://wiki.github.com/rakudo/rakudo/whats-going-into-rakudo> for a list -of modules we want included in the distribution. +Rakudo Star is an distribution of Perl 6 aimed at early adopters. +This git repository isn't the distribution itself; the repository +contains the tools and scripts used to create a distribution. -This repository doesn't contain a distribution, it contains the tools -and scripts to build a distribution. Run "make VERSION=yyyy.mm" to populate -a distribution image in the rakudo-star-yyyy.mm/ directory. +If you're looking to simply download and run the latest release +of Rakudo Star, please download a .tar.gz file from +http://github.com/rakudo/star/downloads . -*** This task should only be done by a release manager, or for testing -your changes if you want to contribute to Rakudo Star. If you just want -to use Rakudo Star, please download a pre-built tar.gz from -http://github.com/rakudo/star/downloads *** +If you're still reading this, we assume you're a Rakudo Star +release manager, or someone that is looking to create new +Perl 6 distributions based on the tools here. Run +"make VERSION=yyyy.mm" to populate a distribution image +into the rakudo-star-yyyy.mm/ directory. The build system assumes that you have the following tools available: @@ -23,9 +25,11 @@ The build system assumes that you have the following tools available: * tar * touch +See <http://wiki.github.com/rakudo/rakudo/whats-going-into-rakudo> for a list +of modules we want included in the distribution. + The skel/ directory contains the basic layout of documentation and other support files, other components are then populated into to the target directory via the make command above. To create a candidate release tarball, try "make release VERSION=yyyy.mm". - |