diff options
author | Jan Niklas Hasse <jhasse@bixense.com> | 2019-11-24 11:55:14 (GMT) |
---|---|---|
committer | Jan Niklas Hasse <jhasse@bixense.com> | 2019-11-24 11:58:31 (GMT) |
commit | f37d101fdc6ee659ee2e919c4437b298c584be56 (patch) | |
tree | 30e9a8ba0ed4e3ab75b2e02e8af9c2e915ae30de /README.md | |
parent | a37da20ae74c81703b1c811182fc154d95ed46fe (diff) | |
download | Ninja-f37d101fdc6ee659ee2e919c4437b298c584be56.zip Ninja-f37d101fdc6ee659ee2e919c4437b298c584be56.tar.gz Ninja-f37d101fdc6ee659ee2e919c4437b298c584be56.tar.bz2 |
Add basic build instructions to the README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 35 |
1 files changed, 31 insertions, 4 deletions
@@ -11,13 +11,40 @@ 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. + +## Building Ninja itself + +You can either build Ninja via the custom generator script written in Python or +via CMake. For more details see +[the wiki](https://github.com/ninja-build/ninja/wiki). + +### Python + +``` +./configure.py --bootstrap +``` + +This will generate the `ninja` binary and a `build.ninja` file you can now use +to built Ninja with itself. + +### CMake + +``` +cmake -Bbuild-cmake -H. +cmake --build build-cmake +``` + +The `ninja` binary will now be inside the `build-cmake` directory (you can +choose any other name you like). + +To run the unit tests: + +``` +./build-cmake/ninja_test +``` |