| commit | 39fc9a45a57efe250ffde988941b55105d293577 | [log] [tgz] |
|---|---|---|
| author | Miguel Osorio <miguelosorio@google.com> | Thu Oct 31 15:05:40 2019 -0700 |
| committer | Miguel Osorio <miguelaosoriol@gmail.com> | Thu Oct 31 20:50:34 2019 -0700 |
| tree | 8b5337b58b7b751796381687153aa93f66166148 | |
| parent | 838daa0c529de6fe6303b9c4e40802ef6d8bec0c [diff] |
[doc] Fix make commands in {fpga,sw} user guides
* Point to make -C sw/device, since this is where the device Make
scaffolding lives.
* Add explicit make boot_rom command in fpga getting started
instructions. Some users are running into problems due to the fact
that the boot_rom file dependency is not checked at FPGA bitstream
build time and the instructions don't explicitly call out the make
command for boot_rom.
Keeping instructions in Make format as requested by
lowrisc/opentitan#733.
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 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).