Skip to content

Commit

Permalink
Add additional information to README
Browse files Browse the repository at this point in the history
Provide a reference to the rendered documentation, CI status, and
releases. Update the status section to reflect things as they are.
  • Loading branch information
harrisonmutai-arm committed Sep 19, 2024
1 parent 3ed5369 commit d4cb2dd
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 47 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[![Build Status](https://github.com/FirmwareHandoff/firmware_handoff/actions/workflows/main.yml/badge.svg)](https://github.com/FirmwareHandoff/firmware_handoff/actions/workflows/main.yml)
[![Release Version](https://img.shields.io/github/v/release/FirmwareHandoff/firmware_handoff?label=release)](https://github.com/FirmwareHandoff/firmware_handoff/releases)

This repository contains the Firmware Handoff specification, which defines a
data structure to transfer essential configuration information between firmware
stages during platform initialization.

The documentation is generated using the Sphinx framework. A version of this
specification, rendered in HTML, is available
[here](https://firmwarehandoff.github.io/firmware_handoff/).

Project dependencies
====================

For an Ubuntu development machine, install the following packages to build the specification:

- `librsvg2-bin`
- `python3-sphinx`
- `python3-sphinxcontrib.svg2pdfconverter`
- `python3-sphinx-rtd-theme`
- `latexmk`
- `texlive-latex-extra`

**Note:** This list has been tested on Ubuntu 20.04 LTS and 22.04 LTS running on AArch64 and AMD64.

Building the document
=====================

The following are use to generate the specification:

- pdf:

``` sh
make latexpdf
```

- html:

``` sh
make latexpdf
```

The output of these build commands goes into subdirectory `build`.

Status
======

The first release of the specification has been published. We are currently in
the implementation phase, looking at various target projects, including U-Boot,
coreboot, TF-A and Tianocore. Once this is done we will review the result to see
if any serious flaws have come to light, meaning that changes are needed. If
so, these will be undertaken in each project.

By the end of 2023, the spec will be considered stable and will be published
as version 1. From there on, backwards compatibility will be maintained.
47 changes: 0 additions & 47 deletions readme.rst

This file was deleted.

0 comments on commit d4cb2dd

Please sign in to comment.