| commit | b66e6e35744e0650768db26ddb56f4e504ce3a45 | [log] [tgz] |
|---|---|---|
| author | Gaurang Chitroda <gaurangg@google.com> | Wed Nov 06 12:00:49 2019 -0800 |
| committer | sriyerg <46467186+sriyerg@users.noreply.github.com> | Fri Nov 08 11:46:22 2019 -0800 |
| tree | 1a03529a98e669c80bf9787fbf52d0b81006139e | |
| parent | 39db686896e76e6bca674c23c88288003f46813e [diff] |
[doc] common_ifs documentation update - Update documentation for pins_if and clk_rst_if - Add pins_if functional diagram - Rename README.md to index.md to comply with documentation methodology and update related references in other documents Signed-off-by: Gaurang Chitroda <gaurangg@google.com>
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 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 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).
