Move all docs to toplevel docs/ folder.

Change-Id: Icea0a02d4f43f591227056aea24cd863ed94c7c3
Reviewed-on: https://gn-review.googlesource.com/2420
Reviewed-by: Brett Wilson <brettw@chromium.org>
Commit-Queue: Brett Wilson <brettw@chromium.org>
9 files changed
tree: c20a87fd61a8916b6d0be94aee7a4aabc4e62185
  1. base/
  2. build/
  3. docs/
  4. infra/
  5. tools/
  6. util/
  7. .clang-format
  8. .editorconfig
  9. .gitignore
  10. .style.yapf
  11. AUTHORS
  12. LICENSE
  13. README.md
README.md

GN

GN is a meta-build system that generates build files for Ninja.

Getting started

git clone https://gn.googlesource.com/gn
cd gn
python build/gen.py
ninja -C out

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.

Sending patches

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

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

Then, to upload a change for review:

git commit
git push origin HEAD:refs/for/master  # This uploads for review.

When revising a change, use:

git commit --amend
git push origin HEAD:refs/for/master

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.