| commit | 544ac9b0bd6441130d21ffa08ff04ef45632792c | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Wed Oct 30 22:56:32 2019 +0000 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Wed Oct 30 23:02:38 2019 +0000 |
| tree | fff3b220ed618049962f24729109221db0056d4e | |
| parent | ac1ece3b4d19658bee202d0c34b52d7118d7e8dc [diff] |
[doc] Adjust binary file names in getting started guide The file names of build outputs changed and don't match the directory they're in any more. Update the docs for that.
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).