summaryrefslogtreecommitdiffstats
path: root/README
blob: 66a651601fd1c90637cf7fe3158faaa7e0ea5550 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Ninja is a small build system with a focus on speed.
http://martine.github.com/ninja/

See the manual -- http://martine.github.com/ninja/manual.html or
doc/manual.asciidoc included in the distribution -- for background
and more details.

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
copied to appropriate locations.

If you're interested in making changes to Ninja, read HACKING.md first.