Skip to content

Commit

Permalink
Update README.md (#263)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinCappos authored Feb 27, 2024
1 parent 5ad20b7 commit c9a26af
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Uptane Standard

[Uptane](https://uptane.github.io) is the first compromise-resilient software update security system for the automotive industry. In 2018, a working group under [IEEE-ISTO](https://ieee-isto.org/) began the process of describing the system's design, implementation, and deployment as a formal standard. On July 31, 2019 IEEE/ISTO released *IEEE-ISTO 6100.1.0.0: Uptane Standard for Design and Implementation* (see link below under documentation). Uptane is now a [Linux Foundation Joint Development Foundation](http://www.jointdevelopment.org/) project. The most recent version of the Standard [version 2.1.0](https://uptane.github.io/uptane-standard/2.1.0/uptane-standard.html) was released on June 27, 2023.
[Uptane](https://uptane.org) is the first compromise-resilient software update security system for the automotive industry. In 2018, a working group under [IEEE-ISTO](https://ieee-isto.org/) began the process of describing the system's design, implementation, and deployment as a formal standard. On July 31, 2019 IEEE/ISTO released *IEEE-ISTO 6100.1.0.0: Uptane Standard for Design and Implementation* (see link below under documentation). Uptane is now a [Linux Foundation Joint Development Foundation](http://www.jointdevelopment.org/) project. The most recent version of the Standard [version 2.1.0](https://uptane.org/docs/standard/uptane-standard) was released on June 27, 2023.

This repository is the public home of all standardization work for Uptane.

Expand All @@ -12,17 +12,12 @@ Major and minor release dates are set by the Uptane Standards committee. All fin

The Uptane Standards document should be considered the authoritative resource for the framework. Several other documents and materials are available or currently in development. The information in all of these other guidelines should be viewed as complementary to the official Uptane Standard, and as recommendations rather than mandatory instructions.

* [Uptane Standard v.2.1.0](https://uptane.github.io/uptane-standard/2.1.0/uptane-standard.html
* [Deployment Best Practices v.2.0.0](https://uptane.github.io/papers/V2.0.0_uptane_deploy.html)
* [Uptane POUF (Protocols, Operations, Usage, and Formats) Guidelines](https://uptane.github.io/pouf.html)
* [Example POUF](https://uptane.github.io/reference_pouf.html)
* [Uptane Standard v.2.1.0](https://uptane.org/docs/2.1.0/standard/uptane-standard)
* [Deployment Best Practices v.2.1.0](https://uptane.org/docs/2.1.0/deployment/best-practices)
* [Uptane POUF (Protocols, Operations, Usage, and Formats) Guidelines](https://uptane.org/enhancements/pouf/pouf-main)
* [Example POUF](https://uptane.org/docs/enhancements/pouf/pouf1)

## Building/rendering the document

We use [kramdown-rfc2629](https://github.com/cabo/kramdown-rfc2629) to render the Markdown source into xml, and [xml2rfc](https://xml2rfc.tools.ietf.org/) to render the XML into HTML or plaintext. A Makefile is included for convenience. You can also render using [Docker](https://www.docker.com/) if you don't wish to install the tools. See `make help` for options.

### Pushing to GitHub pages

The rendered HTML from the markdown source at `master` will be available at https://uptane.github.io/uptane-standard/uptane-standard.html. You can update this, if you have commit rights to this repository, by pushing `uptane-standard.html` to the `gh-pages` branch.

TODO: Set up CI to auto-push on merge to master.

0 comments on commit c9a26af

Please sign in to comment.