| commit | 17ece93073bafb05cb6bb251e4f32a2343d230a5 | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Wed Oct 30 14:49:24 2019 +0000 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Wed Oct 30 15:48:07 2019 +0000 |
| tree | cd60f3263c40ddeb8458345684af6defb0fdc5b0 | |
| parent | 542e220bdfd5fb34a86827fdba6844693994a679 [diff] |
[doc] Document the installing of all required packages We have a section at the beginning of the "Install Build Requirements" outlining the packages which need to be installed. This section included not all packages, some others were distributed across the guide. Worse, the library dependencies for building the spiflash tool were missing (they are only listed in the README of the tool itself). I've restructured the section to include all packages which we need.
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.
$ sudo apt install python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./opentitan-docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:5500.
Have a look at CONTRIBUTING.md 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).