| commit | 4fbe98ff8ec55b89bb5e3c51f3ac8cb85fff5394 | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Tue Feb 25 12:54:20 2020 +0000 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Tue Feb 25 15:02:45 2020 +0000 |
| tree | 6d764148c50ea0600f1df216c055ea1d19e345a1 | |
| parent | d0b343709d0755254ba862be6ee3ba804ea0cdd8 [diff] |
[CI] Optionally pass repository source to template We have an Azure Pipelines template to install all build requirements for OpenTitan, which assumes it is being called from the root of the OpenTitan repository. This assumption is violated if the template is included from another repository, as described in the docs at https://docs.microsoft.com/en-us/azure/devops/pipelines/process/templates?view=azure-devops#use-other-repositories. For this use case, this commit introduces a template parameter `REPO_TOP`, which defaults to `.`. In cases where this default isn't applicable (i.e. whenever this template is used from another repo), it can be overwritten as needed. The name `REPO_TOP` reflects the naming we use in the OpenTitan documentation for the root of the opentitan repository. 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).