commit | 0599e76dbda8e0599205f4bd6c233314fab61eb0 | [log] [tgz] |
---|---|---|
author | Philipp Wagner <phw@lowrisc.org> | Tue Feb 25 12:57:25 2020 +0000 |
committer | Philipp Wagner <mail@philipp-wagner.com> | Tue Feb 25 15:02:45 2020 +0000 |
tree | 1eafd1bae6970253b5b74e5d41d477046d0e3aef | |
parent | 4fbe98ff8ec55b89bb5e3c51f3ac8cb85fff5394 [diff] |
[CI] Ensure apt package index is up-to-date Installing packages with `apt-get` requires the package index to up-to-date. If not, the package installation might fail due to packages being selected for installation which don't exist any more. In hosted CI runners, this step is automatically taken care of, and adding an explicit `apt-get update` is a no-op (except for taking a small amount of time). In other environments, it's essential for correctness. Signed-off-by: Philipp Wagner <phw@lowrisc.org>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository. It exists to enable collaboration across partners participating in the OpenTitan project.
The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.
$ sudo apt install curl python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./build/docs
and starts a local server, which allows you to access the documentation at http://127.0.0.1:1313.
Have a look at CONTRIBUTING for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).