Skip to content

Commit c7339b8

Browse files
authored
README: translate from reStructuredText to Markdown (#2197)
For #2196 **What type of PR is this?** > Documentation **What package or component does this PR mostly affect?** README.rst **What does this PR do? Why is it needed?** Translates README.rst into README.md for more familiarity, easier editing. I tried to keep this as direct as possible with minimal changes to the text or formatting within text. I did fix punctuation and formatting in a few places. Markdown tables can't have multiline cells with internal formatting, so I've translated the tables into paragraphs. **Which issues(s) does this PR fix?** For #2196 **Other notes for review** There are a lot of documentation improvements needed. This is just a first step: I don't want to mix content changes with language changes.
1 parent f5f8aff commit c7339b8

File tree

3 files changed

+839
-1418
lines changed

3 files changed

+839
-1418
lines changed

BUILD.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ filegroup(
7676
"CONTRIBUTORS",
7777
"Design.rst",
7878
"LICENSE",
79-
"README.rst",
79+
"README.md",
8080
"WORKSPACE",
8181
"def.bzl",
8282
"deps.bzl",

0 commit comments

Comments
 (0)