Lines Matching refs:README
1 # README.md files
3 About README.md files.
13 `README.md` files are Markdown files that describe a directory.
16 For example, the file /README.md is rendered when you view the contents of the
21 Also `README.md` at `HEAD` ref is rendered by Gitiles when displaying repository
28 **`README.md` files are intended to provide orientation for engineers browsing
29 your code, especially first-time users.** The `README.md` is likely the first
34 `README.md` file. This is especially important for package directories that
39 Use `README.md`.
41 Files named `README` are not displayed in the directory view in Gitiles.
45 At minimum, every package-level `README.md` should include or point to the