aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteve Mynott <stmuk@users.noreply.github.com>2017-08-06 12:17:03 +0100
committerGitHub <noreply@github.com>2017-08-06 12:17:03 +0100
commit694f91ca0cf115444bd6baeca15059e426072738 (patch)
treeb286da6526f9ef538fc16dd5f105ba77f4ecb476 /README.md
parent8f84de088e62079fc6034ae5f2925da2e0fed47d (diff)
parent1e7ee75684e04e8c90baa490ebfcc7d8098bb984 (diff)
Merge pull request #96 from stmuk/master
Be less misleading with the README shown on github so people less likely to mistake the RBS (Ridiculous Build System) ;-) for the star distro tarball itself
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
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.