Merge pull request #979 from stinb/bootstrap-out-of-source
[platform/upstream/ninja.git] / README
1 Ninja is a small build system with a focus on speed.
2 http://martine.github.com/ninja/
3
4 See the manual -- http://martine.github.com/ninja/manual.html or
5 doc/manual.asciidoc included in the distribution -- for background
6 and more details.
7
8 Binaries for Linux, Mac, and Windows are available at
9   https://github.com/martine/ninja/releases
10 Run './ninja -h' for Ninja help.
11
12 To build your own binary, on many platforms it should be sufficient to
13 just run `./configure.py --bootstrap`; for more details see HACKING.md.
14 (Also read that before making changes to Ninja, as it has advice.)
15
16 Installation is not necessary because the only required file is is the
17 resulting ninja binary. However, to enable features like Bash
18 completion and Emacs and Vim editing modes, some files in misc/ must be
19 copied to appropriate locations.
20
21 If you're interested in making changes to Ninja, read HACKING.md first.