Chromium docs

This directory contains chromium project documentation in Gitiles-flavored Markdown. It is automatically rendered by Gitiles.

If you add new documents, please also add a link to them in the Document Index below.

Creating Documentation

Guidelines

• See the Chromium Documentation Guidelines and the Chromium Documentation Best Practices.
• Markdown documents must follow the Markdown Style Guide.

Previewing changes

Locally using md_browser

# in chromium checkout
./tools/md_browser/md_browser.py

This is only an estimate. The gitiles view may differ.

Online with Gerrit's links to gitiles

1. Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/3362532
2. View a specific .md file. e.g. https://chromium-review.googlesource.com/c/3362532/2/docs/README.md
3. You will see something like
   Base preview -> Patchset 3 preview | DOWNLOAD
   at the top left of the page. Click on the second “preview” link to open the preview for the current patch set.

This gitiles view is the authoritative view, exactly the same as will be used when committed.

Document Index

Note: this is not an exhaustive list of all documents.

Checking Out and Building

• Linux Build Instructions - Linux
• Mac Build Instructions - MacOS
• Windows Build Instructions - Windows
• Android Build Instructions - Android target (on a Linux host)
• Cast Build Instructions - Cast target (on a Linux host)
• Cast for Android Build Instructions - Cast for Android (on a Linux host)
• Fuchsia Build Instructions - Fuchsia target (on a Linux host)
• iOS Build Instructions - iOS target (on a MacOS host)
• Gerrit Guide - Setup Gerrit access
• Chrome OS Build Instructions - Chrome OS
• Linux Chromium ARM Recipes - Recipes for building Chromium for ARM on Linux.
• Chrome Component Build - Faster builds using more libraries
• Using the BuildRunner - Scripts that extract build stops from builders and runs them locally on a slave