Skip to content

Latest commit

 

History

History
350 lines (317 loc) · 17.8 KB

README.md

File metadata and controls

350 lines (317 loc) · 17.8 KB

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.

[TOC]

Creating Documentation

Markdown documents must follow the style guide.

Preview local changes using md_browser:

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

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

Review changes 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/572236
  2. View a specific .md file. e.g. https://chromium-review.googlesource.com/c/572236/2/docs/README.md
  3. Click on gitiles link at top of page.

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

Document Index

Checking Out and Building

Design Docs

Integrated Development Environment (IDE) Set Up Guides

Git

Clang

General Development

Testing

GPU-related docs

Misc Linux-Specific Docs

Misc MacOS-Specific Docs

Misc Windows-Specific Docs

Misc Android-Specific Docs

Misc iOS-Specific Docs

Misc Chrome-OS-Specific Docs

Media

Accessibility

Memory

Memory Infrastructure Timeline Profiling (MemoryInfra)

Misc

Probably Obsolete