dilim/ninja
1
0
Fork 0
mirror of https://github.com/ninja-build/ninja.git synced 2026-06-24 08:48:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix typo, improve formatting in README.md

Browse Source
This commit is contained in:
Jan Niklas Hasse
2026-02-26 22:43:37 +01:00
parent b227a2d8b8
commit 131337bf5c
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -38,10 +38,10 @@ If you have a GoogleTest source directory, you can build the tests
by passing its path with `--gtest-source-dir=PATH` option, or the by passing its path with `--gtest-source-dir=PATH` option, or the
`GTEST_SOURCE_DIR` environment variable, e.g.: `GTEST_SOURCE_DIR` environment variable, e.g.:
``` ```sh
./configure.py --bootstrap --gtest-source-dir=/path/to/googletest ./configure.py --bootstrap --gtest-source-dir=/path/to/googletest
./ninja all # build ninja_test and other auxiliary binaries ./ninja all # build ninja_test and other auxiliary binaries
./ninja_test` # run the unit-test suite. ./ninja_test # run the unit-test suite.
``` ```
Use the CMake build below if you want to use a preinstalled binary Use the CMake build below if you want to use a preinstalled binary
@@ -49,7 +49,8 @@ version of the library.
### CMake ### CMake
To build the ninja binary without building the unit tests, disable test building by setting `BUILD_TESTING` to `OFF`: 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 -Bbuild-cmake -DBUILD_TESTING=OFF
@@ -59,10 +60,11 @@ cmake --build build-cmake
The `ninja` binary will now be inside the `build-cmake` directory (you can The `ninja` binary will now be inside the `build-cmake` directory (you can
choose any other name you like). choose any other name you like).
To run the unit tests, omit the `-DBUILD_TESTING=OFF` option, and after building, run: To run the unit tests, omit the `-DBUILD_TESTING=OFF` option, and after
building, run:
``` ```
./build-cmake/ninja_test build-cmake/ninja_test
``` ```
## Generating documentation ## Generating documentation
@@ -78,9 +80,10 @@ ninja manual doc/manual.html
Which will generate `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: To generate the PDF version of the manual, you must have `dblatext` in your PATH
then do:
``` ```sh
./configure.py # only if you didn't do it previously. ./configure.py # only if you didn't do it previously.
ninja doc/manual.pdf ninja doc/manual.pdf
``` ```
@@ -90,11 +93,11 @@ Which will generate `doc/manual.pdf`.
### Doxygen documentation ### Doxygen documentation
If you have `doxygen` installed, you can build documentation extracted from C++ 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 declarations and comments to help you navigate the code. Note that Ninja is a
executable, not a library, so there is no public API, all details exposed here are standalone executable, not a library, so there is no public API, all details
internal. exposed here are internal.
``` ```sh
./configure.py # if needed ./configure.py # if needed
ninja doxygen ninja doxygen
``` ```