| commit | ed7cc909834ca344bc2f0bacedd3228b270cbc00 | [log] [tgz] |
|---|---|---|
| author | Alex Bradbury <asb@lowrisc.org> | Tue Nov 05 11:29:48 2019 +0000 |
| committer | Alex Bradbury <asb@asbradbury.org> | Tue Nov 05 12:23:14 2019 +0000 |
| tree | d7fd163b7a0ebc88a452c201a927c0839f22474d | |
| parent | 84f8e3b59f949ba611049450075bb14e3cea941f [diff] |
[doc] Note the project license in root _index.md It seems worth making this information a little more discoverable. Also point people towards the user guides just below, which has better information on development methodology than the README now. 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).