| commit | 0abad623a20a143d5085964d6475fccd2e4aac3c | [log] [tgz] |
|---|---|---|
| author | Tobias Wölfel <tobias.woelfel@mailbox.org> | Thu Sep 19 16:21:42 2019 +0200 |
| committer | Tobias Woelfel <towoe@users.noreply.github.com> | Wed Sep 25 10:30:23 2019 +0200 |
| tree | 4864b3c12ba7869f147fe566175ebe22c68197c8 | |
| parent | 789c27cbfbc2699e30d69dcb598e28ea7f7089e4 [diff] |
[doc] Shorten verilator software build instruction Use a more concise instruction of how to build the software. Use the target `distclean` instead of `clean` as it forces the recompilation of the lib folder.
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).