From 1e7ee75684e04e8c90baa490ebfcc7d8098bb984 Mon Sep 17 00:00:00 2001 From: Steve Mynott Date: Mon, 31 Jul 2017 15:14:35 +0100 Subject: be less misleading the README shown on github so people less likely to mistake the RBS (Ridiculous Build System) ;-) for the star distro tarball itself --- README.md | 17 +++++++++++++++++ README.star | 17 ----------------- tools/star/MANIFEST.exclude | 2 +- 3 files changed, 18 insertions(+), 18 deletions(-) create mode 100644 README.md delete mode 100644 README.star diff --git a/README.md b/README.md new file mode 100644 index 0000000..52f3a08 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +Rakudo Star -- a useful and usable production distribution of Perl 6 + +This git repository isn't the distribution itself; the repository +contains the tools and scripts used to create a distribution. + +If you're looking to simply download and run the latest release +of Rakudo Star, please download a .tar.gz or .msi file from +https://rakudo.perl6.org/downloads/star/. Note: the tar files available +from github.com are NOT suitable for building Rakudo Star; do not use them. + +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 -f tools/star/Makefile" to populate a distribution image. + +See tools/star/release-guide.pod for the steps needed to build +a candidate release. diff --git a/README.star b/README.star deleted file mode 100644 index 52f3a08..0000000 --- a/README.star +++ /dev/null @@ -1,17 +0,0 @@ -Rakudo Star -- a useful and usable production distribution of Perl 6 - -This git repository isn't the distribution itself; the repository -contains the tools and scripts used to create a distribution. - -If you're looking to simply download and run the latest release -of Rakudo Star, please download a .tar.gz or .msi file from -https://rakudo.perl6.org/downloads/star/. Note: the tar files available -from github.com are NOT suitable for building Rakudo Star; do not use them. - -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 -f tools/star/Makefile" to populate a distribution image. - -See tools/star/release-guide.pod for the steps needed to build -a candidate release. diff --git a/tools/star/MANIFEST.exclude b/tools/star/MANIFEST.exclude index 93436db..6a090c7 100644 --- a/tools/star/MANIFEST.exclude +++ b/tools/star/MANIFEST.exclude @@ -1,2 +1,2 @@ -README.star +README.md tools/star/ -- cgit v1.1