ninja README

The project's README from github.com/ninja-build/ninja. As one markdown file: 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.

If you have a GoogleTest source directory, you can build the tests by passing its path with --gtest-source-dir=PATH option, or the GTEST_SOURCE_DIR environment variable, e.g.:

./configure.py --bootstrap --gtest-source-dir=/path/to/googletest
./ninja all     # build ninja_test and other auxiliary binaries
./ninja_test    # run the unit-test suite.

Use the CMake build below if you want to use a preinstalled binary version of the library.

CMake

To build the ninja binary without building the unit tests, disable test building by setting BUILD_TESTING to OFF:

cmake -Bbuild-cmake -DBUILD_TESTING=OFF
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, omit the -DBUILD_TESTING=OFF option, and after building, run:

build-cmake/ninja_test

Generating documentation

Ninja Manual

You must have asciidoc and xsltproc in your PATH, then do:

./configure.py
ninja manual doc/manual.html

Which will generate doc/manual.html.

To generate the PDF version of the manual, you must have dblatext in your PATH then do:

./configure.py    # only if you didn't do it previously.
ninja doc/manual.pdf

Which will generate doc/manual.pdf.

Doxygen documentation

If you have doxygen installed, you can build documentation extracted from C++ declarations and comments to help you navigate the code. Note that Ninja is a standalone executable, not a library, so there is no public API, all details exposed here are internal.

./configure.py   # if needed
ninja doxygen

Then open doc/doxygen/html/index.html in a browser to look at it.

ninja (ninja-build/ninja)

Searching Database…

13.3K ·GitHub
Ninja
这是什么东西？Ninja 是一个小型构建系统，只有一个目标：快。它是一个程序，负责快速执行你项目的构建步骤——编译和链接。
它是要加到我代码里的库，还是我直接运行的程序？是一个独立运行的程序。Ninja 明确表示它不是一个库，也没有公开的 API——它代码文档里暴露的所有内容都是内部实现。
我怎么把它装到我的电脑上？从项目的 GitHub 发布页下载预编译的二进制文件直接运行就行——没有真正的安装步骤，因为只需要 ninja 这一个文件。运行 ./ninja -h 可以查看它的选项。
使用它还需要安装别的东西吗？不需要——唯一必需的文件就是这一个 ninja 二进制文件。另外可选：从 misc/ 目录复制一些文件，就能获得 Bash 补全以及 Emacs 和 Vim 的编辑模式。
它在 Windows 上也能跑吗，还是只有 Linux 和 macOS 能用？三个平台都行：Linux、Mac 和 Windows 都有官方二进制文件，而且项目的 CI 会在每个平台上进行构建和测试。
Ninja 从哪里获取构建我项目的指令？来自项目里的 build.ninja 文件——Ninja 自己的构建正是这样做的：先生成器脚本生成一个 build.ninja，再用它来编译 Ninja 本身。想了解整体是怎么配合工作的，README 指向了发行包里附带的文档（doc/manual.asciidoc）。
我怎么启用 Bash 补全或者 Emacs 和 Vim 的编辑模式？它们不包含在二进制文件里：把发行包中 misc/ 目录下的相应文件复制到你所用 shell 和编辑器的合适位置即可。
作为普通用户，我需要 Python 或 CMake 吗？不需要——普通用户只需运行预编译的 ninja 二进制文件。Python（自定义生成器脚本）和 CMake 只是构建 Ninja 本身的两种受支持方式，贡献者还可以选择运行基于 GoogleTest 的单元测试。
What are similar projects?TurboBench, cython, elixir, capnproto, Nuitka, spinel, gcc, lz4
Which topics is it in?software-engineering, cmake, unix, build-tool, high-performance, compiler, cpp, c++, performance, command-line-tool, free, tool
Creator
ninja-build
Size
5.3 MB
Stars
13.3K
Updated
CommitOct 15Releasev1.13.2Nov 20
Age
15y
Commits · 90 Days