compiler
/
ninja
mirror of https://github.com/ninja-build/ninja.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
a small build system with a focus on speed
3,080 Commits 2 Branches 29 Tags 14 MiB
C++ 87.7%
Python 7.8%
C 2.2%
CMake 1.1%
Shell 0.5%
Other 0.7%
Go to file
Orgad Shaneh 3d1a5fa9ab RealDiskInterface: Do *not* set locale to an empty string 
It causes the cursor handling to be extremely slow on MinGW.

Added in #2321.

Fixes #2435.
 		2024-05-04 22:50:41 +03:00
.github GitHub Actions: Run output_test.py on Fedora 40 2024-04-27 17:55:42 +02:00
doc Remove trailing whitespace 2024-04-27 15:49:40 +02:00
misc GitHub Actions doesn't seem to have a valid Git repo, fallback to hard-coded ignore list 2024-04-27 17:47:24 +02:00
src RealDiskInterface: Do *not* set locale to an empty string 2024-05-04 22:50:41 +03:00
windows Add longPathAware manifest to enable long paths on Windows 2022-12-13 15:11:33 +01:00
.clang-format
…
.clang-tidy Add cppcoreguidelines-pro-type-cstyle-cast to clang-tidy config 2024-05-02 19:54:08 +02:00
.editorconfig
…
.gitignore Ignore Visual Studios folders 2022-03-05 15:45:11 +01:00
CMakeLists.txt Merge pull request #2422 from Arghnews/update_gtest 2024-04-17 20:51:03 +02:00
CONTRIBUTING.md Remove requirement for Google copyright from CONTRIBUTING 2022-08-30 14:05:10 -04:00
COPYING
…
README.md README.md: document Manual and Doxygen generation 2024-02-13 14:46:06 +01:00
RELEASING.md Convert RELEASING to Markdown and add instruction for GitHub release 2022-08-30 22:37:07 +02:00
appveyor.yml AppVeyor: Update Ubuntu to 22.04 2024-03-16 18:08:57 +01:00
configure.py Move Status interface into its own header 2024-04-14 16:22:02 +02:00

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

Generating documentation

Ninja Manual

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

./configure.py
ninja manual doc/manual.pdf

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.