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/, который идёт в поставке, в подходящие места для вашей оболочки и редактора.
Нужны ли мне 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 17Releasev1.13.2Nov 20
Age
15y
Commits · 90 Days