summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2015-06-30 22:26:20 (GMT)
committerEvan Martin <martine@danga.com>2015-06-30 22:29:15 (GMT)
commit53e5aed022b09d38e219b31cc9af4574cb948327 (patch)
treef32a613f70509bab824671bf6e6152e561585f2c /README
parentd18eda4c3ed7d81c3f8d6d46972a0988f1ebb05e (diff)
downloadNinja-53e5aed022b09d38e219b31cc9af4574cb948327.zip
Ninja-53e5aed022b09d38e219b31cc9af4574cb948327.tar.gz
Ninja-53e5aed022b09d38e219b31cc9af4574cb948327.tar.bz2
point people at more detailed build docs if they're on Windows
It's a hard balance between "most people want to run configure --bootstrap" and "here's a massive wall of text of every detail about building". I think the balance in this change is better than it was before -- most people on Windows don't want to build their own binary. Fixes #983.
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 6 insertions, 5 deletions
diff --git a/README b/README
index 41ecdda..66a6516 100644
--- a/README
+++ b/README
@@ -5,13 +5,14 @@ See the manual -- http://martine.github.com/ninja/manual.html or
doc/manual.asciidoc included in the distribution -- for background
and more details.
-To build, run ./configure.py --bootstrap. It first compiles all non-test
-source files together, then re-builds Ninja using itself. You should
-end up with a 'ninja' binary in the source root.
-
-Run './configure.py --help' for more configuration options.
+Binaries for Linux, Mac, and Windows are available at
+ https://github.com/martine/ninja/releases
Run './ninja -h' for Ninja help.
+To build your own binary, on many platforms it should be sufficient to
+just run `./configure.py --bootstrap`; for more details see HACKING.md.
+(Also read that before making changes to Ninja, as it has advice.)
+
Installation is not necessary because the only required file is is the
resulting ninja binary. However, to enable features like Bash
completion and Emacs and Vim editing modes, some files in misc/ must be