| commit | f57a1b2f965c5a0101b9b5978216d7b5b9712512 | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Wed Oct 16 14:26:52 2019 +0100 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Fri Oct 18 14:13:32 2019 +0100 |
| tree | 8bcd06b57b4078877235b4d749e01f369cad215d | |
| parent | ddc4ed3978313d0e7151dee8c925795491dbbab4 [diff] |
[docs] Document rv_core_ibex rv_core_ibex is a wrapper around ibex_core, which has its own extensive documentation at https://ibex-core.readthedocs.io/. Instead of replicating all this documentation, this commit only attempts to point readers into the right direction, and highlight the additional functionality provided by the wrapper, namely the bus adapters.
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).