7 Ninja is a small build system with a focus on speed.
8 https://ninja-build.org/
10 See [the manual](https://ninja-build.org/manual.html) or
11 `doc/manual.asciidoc` included in the distribution for background
14 Binaries for Linux, Mac, and Windows are available at
15 [GitHub](https://github.com/ninja-build/ninja/releases).
16 Run `./ninja -h` for Ninja help.
18 Installation is not necessary because the only required file is the
19 resulting ninja binary. However, to enable features like Bash
20 completion and Emacs and Vim editing modes, some files in misc/ must be
21 copied to appropriate locations.
23 If you're interested in making changes to Ninja, read
24 [CONTRIBUTING.md](CONTRIBUTING.md) first.
26 ## Building Ninja itself
28 You can either build Ninja via the custom generator script written in Python or
29 via CMake. For more details see
30 [the wiki](https://github.com/ninja-build/ninja/wiki).
35 ./configure.py --bootstrap
38 This will generate the `ninja` binary and a `build.ninja` file you can now use
39 to build Ninja with itself.
44 cmake -Bbuild-cmake -H.
45 cmake --build build-cmake
48 The `ninja` binary will now be inside the `build-cmake` directory (you can
49 choose any other name you like).
51 To run the unit tests:
54 ./build-cmake/ninja_test
61 Version 2.0, January 2010
62 http://www.apache.org/licenses/
64 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
68 "License" shall mean the terms and conditions for use, reproduction,
69 and distribution as defined by Sections 1 through 9 of this document.
71 "Licensor" shall mean the copyright owner or entity authorized by
72 the copyright owner that is granting the License.
74 "Legal Entity" shall mean the union of the acting entity and all
75 other entities that control, are controlled by, or are under common
76 control with that entity. For the purposes of this definition,
77 "control" means (i) the power, direct or indirect, to cause the
78 direction or management of such entity, whether by contract or
79 otherwise, or (ii) ownership of fifty percent (50%) or more of the
80 outstanding shares, or (iii) beneficial ownership of such entity.
82 "You" (or "Your") shall mean an individual or Legal Entity
83 exercising permissions granted by this License.
85 "Source" form shall mean the preferred form for making modifications,
86 including but not limited to software source code, documentation
87 source, and configuration files.
89 "Object" form shall mean any form resulting from mechanical
90 transformation or translation of a Source form, including but
91 not limited to compiled object code, generated documentation,
92 and conversions to other media types.
94 "Work" shall mean the work of authorship, whether in Source or
95 Object form, made available under the License, as indicated by a
96 copyright notice that is included in or attached to the work
97 (an example is provided in the Appendix below).
99 "Derivative Works" shall mean any work, whether in Source or Object
100 form, that is based on (or derived from) the Work and for which the
101 editorial revisions, annotations, elaborations, or other modifications
102 represent, as a whole, an original work of authorship. For the purposes
103 of this License, Derivative Works shall not include works that remain
104 separable from, or merely link (or bind by name) to the interfaces of,
105 the Work and Derivative Works thereof.
107 "Contribution" shall mean any work of authorship, including
108 the original version of the Work and any modifications or additions
109 to that Work or Derivative Works thereof, that is intentionally
110 submitted to Licensor for inclusion in the Work by the copyright owner
111 or by an individual or Legal Entity authorized to submit on behalf of
112 the copyright owner. For the purposes of this definition, "submitted"
113 means any form of electronic, verbal, or written communication sent
114 to the Licensor or its representatives, including but not limited to
115 communication on electronic mailing lists, source code control systems,
116 and issue tracking systems that are managed by, or on behalf of, the
117 Licensor for the purpose of discussing and improving the Work, but
118 excluding communication that is conspicuously marked or otherwise
119 designated in writing by the copyright owner as "Not a Contribution."
121 "Contributor" shall mean Licensor and any individual or Legal Entity
122 on behalf of whom a Contribution has been received by Licensor and
123 subsequently incorporated within the Work.
125 2. Grant of Copyright License. Subject to the terms and conditions of
126 this License, each Contributor hereby grants to You a perpetual,
127 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
128 copyright license to reproduce, prepare Derivative Works of,
129 publicly display, publicly perform, sublicense, and distribute the
130 Work and such Derivative Works in Source or Object form.
132 3. Grant of Patent License. Subject to the terms and conditions of
133 this License, each Contributor hereby grants to You a perpetual,
134 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
135 (except as stated in this section) patent license to make, have made,
136 use, offer to sell, sell, import, and otherwise transfer the Work,
137 where such license applies only to those patent claims licensable
138 by such Contributor that are necessarily infringed by their
139 Contribution(s) alone or by combination of their Contribution(s)
140 with the Work to which such Contribution(s) was submitted. If You
141 institute patent litigation against any entity (including a
142 cross-claim or counterclaim in a lawsuit) alleging that the Work
143 or a Contribution incorporated within the Work constitutes direct
144 or contributory patent infringement, then any patent licenses
145 granted to You under this License for that Work shall terminate
146 as of the date such litigation is filed.
148 4. Redistribution. You may reproduce and distribute copies of the
149 Work or Derivative Works thereof in any medium, with or without
150 modifications, and in Source or Object form, provided that You
151 meet the following conditions:
153 (a) You must give any other recipients of the Work or
154 Derivative Works a copy of this License; and
156 (b) You must cause any modified files to carry prominent notices
157 stating that You changed the files; and
159 (c) You must retain, in the Source form of any Derivative Works
160 that You distribute, all copyright, patent, trademark, and
161 attribution notices from the Source form of the Work,
162 excluding those notices that do not pertain to any part of
163 the Derivative Works; and
165 (d) If the Work includes a "NOTICE" text file as part of its
166 distribution, then any Derivative Works that You distribute must
167 include a readable copy of the attribution notices contained
168 within such NOTICE file, excluding those notices that do not
169 pertain to any part of the Derivative Works, in at least one
170 of the following places: within a NOTICE text file distributed
171 as part of the Derivative Works; within the Source form or
172 documentation, if provided along with the Derivative Works; or,
173 within a display generated by the Derivative Works, if and
174 wherever such third-party notices normally appear. The contents
175 of the NOTICE file are for informational purposes only and
176 do not modify the License. You may add Your own attribution
177 notices within Derivative Works that You distribute, alongside
178 or as an addendum to the NOTICE text from the Work, provided
179 that such additional attribution notices cannot be construed
180 as modifying the License.
182 You may add Your own copyright statement to Your modifications and
183 may provide additional or different license terms and conditions
184 for use, reproduction, or distribution of Your modifications, or
185 for any such Derivative Works as a whole, provided Your use,
186 reproduction, and distribution of the Work otherwise complies with
187 the conditions stated in this License.
189 5. Submission of Contributions. Unless You explicitly state otherwise,
190 any Contribution intentionally submitted for inclusion in the Work
191 by You to the Licensor shall be under the terms and conditions of
192 this License, without any additional terms or conditions.
193 Notwithstanding the above, nothing herein shall supersede or modify
194 the terms of any separate license agreement you may have executed
195 with Licensor regarding such Contributions.
197 6. Trademarks. This License does not grant permission to use the trade
198 names, trademarks, service marks, or product names of the Licensor,
199 except as required for reasonable and customary use in describing the
200 origin of the Work and reproducing the content of the NOTICE file.
202 7. Disclaimer of Warranty. Unless required by applicable law or
203 agreed to in writing, Licensor provides the Work (and each
204 Contributor provides its Contributions) on an "AS IS" BASIS,
205 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
206 implied, including, without limitation, any warranties or conditions
207 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
208 PARTICULAR PURPOSE. You are solely responsible for determining the
209 appropriateness of using or redistributing the Work and assume any
210 risks associated with Your exercise of permissions under this License.
212 8. Limitation of Liability. In no event and under no legal theory,
213 whether in tort (including negligence), contract, or otherwise,
214 unless required by applicable law (such as deliberate and grossly
215 negligent acts) or agreed to in writing, shall any Contributor be
216 liable to You for damages, including any direct, indirect, special,
217 incidental, or consequential damages of any character arising as a
218 result of this License or out of the use or inability to use the
219 Work (including but not limited to damages for loss of goodwill,
220 work stoppage, computer failure or malfunction, or any and all
221 other commercial damages or losses), even if such Contributor
222 has been advised of the possibility of such damages.
224 9. Accepting Warranty or Additional Liability. While redistributing
225 the Work or Derivative Works thereof, You may choose to offer,
226 and charge a fee for, acceptance of support, warranty, indemnity,
227 or other liability obligations and/or rights consistent with this
228 License. However, in accepting such obligations, You may act only
229 on Your own behalf and on Your sole responsibility, not on behalf
230 of any other Contributor, and only if You agree to indemnify,
231 defend, and hold each Contributor harmless for any liability
232 incurred by, or claims asserted against, such Contributor by reason
233 of your accepting any such warranty or additional liability.
235 END OF TERMS AND CONDITIONS
237 APPENDIX: How to apply the Apache License to your work.
239 To apply the Apache License to your work, attach the following
240 boilerplate notice, with the fields enclosed by brackets "[]"
241 replaced with your own identifying information. (Don't include
242 the brackets!) The text should be enclosed in the appropriate
243 comment syntax for the file format. We also recommend that a
244 file or class name and description of purpose be included on the
245 same "printed page" as the copyright notice for easier
246 identification within third-party archives.
248 Copyright [yyyy] [name of copyright owner]
250 Licensed under the Apache License, Version 2.0 (the "License");
251 you may not use this file except in compliance with the License.
252 You may obtain a copy of the License at
254 http://www.apache.org/licenses/LICENSE-2.0
256 Unless required by applicable law or agreed to in writing, software
257 distributed under the License is distributed on an "AS IS" BASIS,
258 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
259 See the License for the specific language governing permissions and
260 limitations under the License.
