Mention optional files in installation instructions
[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 ./bootstrap.py.  It first blindly 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.  Run './ninja -h' for
11 help.
12
13 Installation is not necessary because the only required file is is the
14 resulting ninja binary. However, to enable features like Bash
15 completion and Emacs and Vim editing modes, some files in misc/ must be
16 copied to appropriate locations.
17
18 If you're interested in making changes to Ninja, read HACKING.md first.