examples: Modify README formatting #9
Conversation
| * https://github.com/OpenAMP/open-amp#example-to-compile-zynq-ultrascale-mpsoc-r5-genericbaremetal-remote | ||
| * RPU firmware elf file is expected in sdk at path: /lib/firmware/ | ||
| * This build step needs Xilinx Vendor specific toolchain xsdb | ||
| * Instructions to compile |
There was a problem hiding this comment.
you change the hierarchy here, seems strange to have the bullets below at same level.
suggestion s/* /## /
There was a problem hiding this comment.
I added 3 spaces instead of two spaces. Also, adding ## generates heading index in sphinx documentation. I am trying to avoid it.
There was a problem hiding this comment.
I see what you mean. So, when I change hierarchy, I need to move indentation as well from the title. I will modify formatting for each README.md and keep 2 space of indentation and indent bullets and subtitles as required.
There was a problem hiding this comment.
I have to create subtitle line i.e. starts with ## and Bullet line i.e. starts with * at the same indent level for sphinx to generate Bullet point. Otherwise I don't see Bullet point. So, I will keep both at same indent level.
|
|
||
| ## How to run on zcu102 board/QEMU: | ||
| Assume all the binaries are zcu102 board specific. | ||
| https://github.com/OpenAMP/open-amp#example-to-compile-zynq-ultrascale-mpsoc-r5-genericbaremetal-remote |
There was a problem hiding this comment.
Please link to line in README.md not to project front page.
This apples everywhere you do this.
Current README.md contains many titles with # prefix of each line. It generates lots of indexes when these README files are linked in openamp-docs repo. Remove redundant # prefix. Only keep it for demo title, compilation steps and demo run steps. This way, openamp-docs generates minimal index in table of content. Signed-off-by: Tanmay Shah <tanmay.shah@amd.com>
tnmysh
requested review from
arnopo and
wmamills
and removed request for
arnopo
Current README.md contains many titles with # prefix of each line. It generates lots of indexes when these README files are linked in openamp-docs repo.
Remove redundant # prefix. Only keep it for demo title, compilation steps and demo run steps. This way, openamp-docs generates minimal index in table of content.
Also re-edit README.md files for better presentation.
Signed-off-by: Tanmay Shah tanmay.shah@amd.com