| commit | 0c2e3620f16f3d4b7d62f5a7517e4d982a0d1aba | [log] [tgz] |
|---|---|---|
| author | Alex Bradbury <asb@lowrisc.org> | Mon Nov 04 23:58:53 2019 +0000 |
| committer | Alex Bradbury <asb@asbradbury.org> | Tue Nov 05 05:48:31 2019 +0000 |
| tree | 3e8a8671544323505bad79946d91330a84ff1cae | |
| parent | 5bbb164981c319a89c5babc3ed2ee11640395f6d [diff] |
[doc] Add short description of governance structure This brief summary outlines the key components of the governance structure, and defers to the linked Technical Charter PDF for full info. Signed-off-by: Alex Bradbury <asb@lowrisc.org>
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.
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.
Download and install hugo-extended.
Ensure that you have the required Python modules installed (to be executed in the repository root):
$ 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 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).