search

jmbaur / tinyboot

A linuxboot payload for coreboot
MIT License
16 stars 1 forks source link

chore: README changes #17

Closed johnrichardrinehart closed 1 year ago

johnrichardrinehart commented 1 year ago

Description

I was taking a look at this project and thought I'd rake through the README. Please consider the change set. I tried to address:

  1. Repairing the external URL to the UAPI Group's Boot Loader Spec.
  2. Code spans for project names ("proper nouns")
  3. Adding a subsection for the description/overview content.

Please note that the flake URL no longer seems to resolve to any buildable (tested with a few different board attributes):

$ nix build .\#coreboot.qemu-aarch64.config.build.<tab><tab>
.\#coreboot.qemu-aarch64.config.build.baseInitrd
.\#coreboot.qemu-aarch64.config.build.coreboot  
.\#coreboot.qemu-aarch64.config.build.firmware  
.\#coreboot.qemu-aarch64.config.build.fitImage  
.\#coreboot.qemu-aarch64.config.build.initrd    
.\#coreboot.qemu-aarch64.config.build.linux     
.\#coreboot.qemu-aarch64.config.build.qemuScript
.\#coreboot.qemu-aarch64.config.build.testScript

Maybe it's obvious how to change the Usage section but I wasn't sure how to amend it.

jmbaur commented 1 year ago

Thank you!