block by roachhd a8afb5c9f23b4c04c4e1


README-README: A Style Guide for README files


The file and supporting documents should describe the following, in this order. If the file starts getting long, break it into pieces


Supporting Documentation

Besides a, your repo should contain a summarizing major code changes, a describing the code’s license (typically Apache 2.0 for our open-source projects, All Rights Reserved for internal projects), and a notes/ directory that is a git submodule of the project’s wiki. See the style guide for repo organization for more details.