From 3f13cc9c3aeccba2af68238d91e5e387dc3a7fcc Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Fri, 10 Aug 2012 12:02:29 -0700 Subject: [PATCH] README.md: Don't assume the user has downloaded Factor yet. Instructions on how to clone git and build the latest Factor. --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 913bdbb789..134d90b7fd 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,40 @@ license. ## Getting Started -If you are reading this README file, you either downloaded a binary -package, or checked out Factor sources from the GIT repository. - * [Learning Factor](http://concatenative.org/wiki/view/Factor/Learning) * [System requirements](http://concatenative.org/wiki/view/Factor/Requirements) -* [Building Factor from source](http://concatenative.org/wiki/view/Factor/Building%20Factor) (don't do this if you're using a binary package) -To run Factor: +### Building Factor from source + +If you have a build environment set up, then you can build Factor from git. +These scripts will attempt to compile the Factor binary and bootstrap from +a boot image stored on factorcode.org. + +To check out Factor: + +* git clone git://factorcode.org/git/factor.git +* cd factor + +To build the latest complete Factor system from git: + +* Windows: build-support\factor.cmd +* Unix: ./build-support/factor.sh update + +Now you should have a complete Factor system ready to run. + +[More information on building factor](http://concatenative.org/wiki/view/Factor/Building%20Factor) + +### To run a Factor binary: + +You can download a Factor binary from the grid on [http://factorcode.org](http://factorcode.org). +The nightly builds are usually a better experience than the point releases. * Windows: Double-click `factor.exe`, or run `.\factor.com` in a command prompt * Mac OS X: Double-click `Factor.app` or run `open Factor.app` in a Terminal * Unix: Run `./factor` in a shell +### Learning Factor + A tutorial is available that can be accessed from the Factor environment: ```factor -- 2.34.1