Clone this repo:
  1. b199e54 [docs] : Split 'gn help' heading and usage summary when exceed 80 cols by Joe Armstrong · 29 hours ago master
  2. 5bc90b6 stdout: use dim colors by Elly Fong-Jones · 15 hours ago
  3. 24411be Make gn check faster by Takuto Ikuta · 2 days ago
  4. 3941394 [docs] regenerate docs/reference.md by Joe Armstrong · 7 days ago
  5. 93ac4e0 Some documentation of gn check --check-generated by Daniel Bratell · 8 days ago

GN

GN is a meta-build system that generates build files for Ninja. There is documentation in docs/ and a presentation on it.

Getting started

You can download the latest version of GN binary for Linux, macOS and Windows.

Alternatively, you can build GN from source:

git clone https://gn.googlesource.com/gn
cd gn
python build/gen.py
ninja -C out
# To run tests:
out/gn_unittests

On Windows, it is expected that cl.exe, link.exe, and lib.exe can be found in PATH, so you'll want to run from a Visual Studio command prompt, or similar.

On Linux and Mac, the default compiler is clang++, a recent version is expected to be found in PATH. This can be overridden by setting CC, CXX, and AR.

Reporting bugs

If you find a bug, you can see if it is known or report it in the bug database.

Sending patches

GN uses Gerrit for code review. The short version of how to patch is:

Register at https://gn-review.googlesource.com.

... edit code ...
ninja -C out && out/gn_unittests

Then, to upload a change for review:

git commit
git cl upload --gerrit

When revising a change, use:

git commit --amend
git cl upload --gerrit

which will add the new changes to the existing code review, rather than creating a new one.

We ask that all contributors sign Google's Contributor License Agreement (either individual or corporate as appropriate, select ‘any other Google project’).

Community

You may ask questions and follow along w/ GN‘s development on Chromium’s gn-dev@ Google Group.