diff options
| author | Jan Niklas Hasse <jhasse@bixense.com> | 2019-08-30 11:07:58 (GMT) |
|---|---|---|
| committer | Jan Niklas Hasse <jhasse@bixense.com> | 2019-11-24 11:58:31 (GMT) |
| commit | a37da20ae74c81703b1c811182fc154d95ed46fe (patch) | |
| tree | d1638a3a01b775c2c8ef05f39c7c02932d3c062e /README.md | |
| parent | 6ee71118b87935c6629f69a41bfa531925ef44c2 (diff) | |
| download | Ninja-a37da20ae74c81703b1c811182fc154d95ed46fe.zip Ninja-a37da20ae74c81703b1c811182fc154d95ed46fe.tar.gz Ninja-a37da20ae74c81703b1c811182fc154d95ed46fe.tar.bz2 | |
Use short CONTRIBUTING.md instead of HACKING.md
* Only the most important parts and some new guidelines in
CONTRIBUTING.md.
* Complete HACKING.md content moved to the GitHub wiki:
https://github.com/ninja-build/ninja/wiki
* README is now also Markdown formatted.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a1c78d --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Ninja + +Ninja is a small build system with a focus on speed. +https://ninja-build.org/ + +See [the manual](https://ninja-build.org/manual.html) or +`doc/manual.asciidoc` included in the distribution for background +and more details. + +Binaries for Linux, Mac, and Windows are available at + [GitHub](https://github.com/ninja-build/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 +[the wiki](https://github.com/ninja-build/ninja/wiki). + +Installation is not necessary because the only required file 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 CONTRIBUTING.md first. |