Add README.fuchsia

Fuchsia-Only: Documentation

Bug: 91545
Original-Change-Id: I6c8261106d5a21c132644b4e957201b393a67d26
Original-Change-Id: I86274252e4930b72a2866dd6527d7d5ed2d4dca4
Original-Change-Id: I4182bad709bf4758a1b0f47006a19807bf01a7b0
Original-Change-Id: Ic3abe9985c35a0be73964f0701e6f5670c45bf9a
Original-Change-Id: I6d55df2048b84ca859d7a7242c815e6d6db6da1a
Change-Id: Ia591e68f30aaa2faeb78c9b08e34b66a1cd8132f
Reviewed-on: https://fuchsia-review.googlesource.com/c/third_party/github.com/ninja-build/ninja/+/970032
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
Reviewed-by: David Fang <fangism@google.com>
Reviewed-by: Jay Zhuang <jayzhuang@google.com>
Fuchsia-Auto-Submit: David Turner <digit@google.com>
Reviewed-by: Tyler Mandry <tmandry@google.com>
1 file changed
tree: 0ffd34003d5579a6cbd22c090a20cafd758c2024
  1. .github/
  2. doc/
  3. misc/
  4. src/
  5. windows/
  6. .clang-format
  7. .clang-tidy
  8. .editorconfig
  9. .gitignore
  10. appveyor.yml
  11. CMakeLists.txt
  12. configure.py
  13. CONTRIBUTING.md
  14. COPYING
  15. README.fuchsia
  16. README.md
  17. RELEASING.md
README.md

Ninja

Ninja is a small build system with a focus on speed. https://ninja-build.org/

See the manual or doc/manual.asciidoc included in the distribution for background and more details.

Binaries for Linux, Mac and Windows are available on GitHub. Run ./ninja -h for Ninja help.

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.

Python

./configure.py --bootstrap

This will generate the ninja binary and a build.ninja file you can now use to build Ninja with itself.

CMake

cmake -Bbuild-cmake
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