On 04/23/20 02:45, Sean Brogan wrote: > I was hoping that because it wasn't "HTML tag soup" that build status could > be front and center in the package readme as I find that more in line with > expectations on github based projects. Nesting it deeper in the package > just means less people find it when looking at your package. But I could > see a few ways to solve it so I am looking for feedback and alignment before > doing anything else. > > Option 1. > > 1. Add the Platform CI build status for the three platforms to the Edk2 repo > readme since these are platforms in edk2 this makes sense and brings the most > visibility to their status and the existence of the builds. > 2. Convert edk2 repo readme to RST so it avoids "HTML tag soup" > 3. Move the remaining part of the OvmfPkg/Readme.rst file into > OvmfPkg/PlatformCI/Readme.md (I prefer MD when not doing large tables of > links as it is easier to write and slightly easier to read as plain text). > 4. Do step 3 for ArmVirtPkg and EmulatorPkg too > > Option 2. > 1. Leave the ReadMe.rst at the root of each package but only include the > build status table and add a link to the PlatformCi/ReadMe.md > 2. Move the Pytool and Platform CI focused readme contents to > PlatformCI/ReadMe.md > > Option 3. > > Something else. > > Finally does anyone have a strong preference for ReadMe vs README vs readme > vs Readme vs ReAdMe? I see a mix of these in the edk2 code tree.
Sorry, I didn't mean to ignore this sub-thread, I just got to see the other email (about the V10 branch) first. My understanding is that V10 has come to a resolution about the questions above; and I'm happy with V10 (as I stated in that thread). Thanks! Laszlo -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#58065): https://edk2.groups.io/g/devel/message/58065 Mute This Topic: https://groups.io/mt/73210237/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
