Skip to content

docs: update README.md with current information#293

Open
amd-aliem wants to merge 5 commits into
AMDESE:mainfrom
amd-aliem:readme-rewrite
Open

docs: update README.md with current information#293
amd-aliem wants to merge 5 commits into
AMDESE:mainfrom
amd-aliem:readme-rewrite

Conversation

@amd-aliem
Copy link
Copy Markdown

Link to rendered doc, for easier review: https://github.com/amd-aliem/AMDSEV/blob/readme-rewrite/README.md

New:

  • Add top-level heading and SEV Features table mapping SEV versions to EPYC platforms
  • Add link to AMD SEV Enablement Guide (which uses new SEV X.X naming scheme for features)
  • Add Branch Structure table documenting main vs tsm branches
  • Add link to sev-certify repository for distro compatibility
  • Add snphost ok recommendation for host readiness checks

Restructured:

  • Add consolidated Upstream Version Reference matrix (replaces three separate tables)
  • Consolidate HW and FW checks into single Prepare Host Section
  • Make Branch Structure and Build subsections under Build and Install
  • Add skip-note for users who don't need to build from source

Fixed:

  • Fix typos: "Branhes" → "Branches", "succesful" → "successful", "satisify" → "satisfy"
  • Fix double spaces and extra whitespace in FAQ section
  • Fix extra space in [ How to increase SWIOTLB limit] link
  • Standardize code fences from quadruple to triple backticks
  • Escape *.deb / *.rpm glob characters in markdown
  • Add missing punctuation for PCIe r6.1+ sentence

amd-aliem added 2 commits May 11, 2026 18:20
- Add SEV Features table and consolidated Feature description tables
- Add Hardware & BIOS Requirements section (CPU, BIOS settings, firmware update, verification)
- Add Branch Structure table and snphost ok / sev-certify references
- Reorganize firmware update instructions and build sections
- Fix typos, broken cross-references, and inconsistent formatting

Signed-off-by: Amanda Liem <aliem@amd.com>
Comment thread README.md
amd-aliem added 3 commits May 13, 2026 23:24
Signed-off-by: Amanda Liem <aliem@amd.com>
Signed-off-by: Amanda Liem <aliem@amd.com>
Signed-off-by: Amanda Liem <aliem@amd.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants