Merge pull request #809 from andrey-malets/doc-for-first-output
[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 To build, run ./configure.py --bootstrap.  It first compiles all non-test
9 source files together, then re-builds Ninja using itself.  You should
10 end up with a 'ninja' binary in the source root.
11
12 Run './configure.py --help' for more configuration options.
13 Run './ninja -h' for Ninja help.
14
15 Installation is not necessary because the only required file is is the
16 resulting ninja binary. However, to enable features like Bash
17 completion and Emacs and Vim editing modes, some files in misc/ must be
18 copied to appropriate locations.
19
20 If you're interested in making changes to Ninja, read HACKING.md first.