Commit c7339b8
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
3 files changed
+839
-1418
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
79 | | - | |
| 79 | + | |
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| |||
0 commit comments