| commit | db9c2710c19c4b16287b901ec56aed44d32c8f67 | [log] [tgz] |
|---|---|---|
| author | Alex Bradbury <asb@lowrisc.org> | Fri Nov 01 04:04:00 2019 +0000 |
| committer | Alex Bradbury <asb@asbradbury.org> | Tue Nov 05 11:14:11 2019 +0000 |
| tree | 574e57083a18ed7f1952b46ce690aed9a115b156 | |
| parent | 6502e5c788c14e2c2cafe04b7647c8c23cc250ac [diff] |
Add Contributor License Agreement This commit adds the text of our Contributor License Agreement (closely derived from the Apache Individual Contributor License Agreement) and adds instructions to CONTRIBUTING.md that explain how you can indicate agreement using the git Signed-off-by mechanism. This text has been reviewed by lowRISC's legal committee. 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 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).