mirror of
https://github.com/lowRISC/ibex.git
synced 2025-04-23 21:39:13 -04:00
830b7f7206
Restructure the existing documentation to group the content by intended audience. This produces four sections: * An introduction section, relevant to "newcomers" to Ibex. * An user guide, intended for hardware designers (integrators) and software developers who want to integrate Ibex, and develop software for it. * A reference guide, which provides background information on the design. This section is essential when working on Ibex, and also documents our design decisions. * A developer guide aimed at people modifying Ibex itself. It consists mostly of process and tool documentation: how to run the verification after a code change, how to use GitHub, etc. This commit is large, but text is mostly unchanged. A couple of introductions and tables of content were added, but no significant changes to the text have been made. These will be done in follow-ups. Signed-off-by: Philipp Wagner <phw@lowrisc.org>
30 lines
1.5 KiB
ReStructuredText
30 lines
1.5 KiB
ReStructuredText
Ibex: An embedded 32 bit RISC-V CPU core
|
|
========================================
|
|
|
|
Ibex is a production-quality open source 32 bit RISC-V CPU core written in SystemVerilog.
|
|
The CPU core is heavily parametrizable and well suited for embedded control applications.
|
|
Ibex is being extensively verified and has seen multiple tape-outs.
|
|
|
|
You are now reading the Ibex documentation.
|
|
The documentation is split into four parts.
|
|
|
|
The :doc:`Overview documentation <01_overview/index>` looks at Ibex from high up.
|
|
It answers questions like what are the high-level properties of Ibex, which standards is Ibex following, and where is it typically used.
|
|
|
|
The :doc:`User Guide <02_user/index>` provides all necessary information to use Ibex.
|
|
It is aimed at hardware developers integrating Ibex into a design, and software developers writing software running on Ibex.
|
|
|
|
The :doc:`Reference Guide <03_reference/index>` provides background information.
|
|
It describes the design in detail, discusses the verification approach and the resulting testbench structures, and generally helps to understand Ibex in depth.
|
|
|
|
The :doc:`Developer Guide <04_developer/index>` is aimed at people making changes to Ibex itself.
|
|
Since Ibex is open source, every user of Ibex is encouraged to learn how to adapt Ibex to their use case, and be part of the open development process.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
01_overview/index.rst
|
|
02_user/index.rst
|
|
03_reference/index.rst
|
|
04_developer/index.rst
|