From c1b95c7917a01d6b693ce30423a3c5197d877b60 Mon Sep 17 00:00:00 2001 From: lkcl Date: Sat, 23 Jul 2022 11:45:31 +0100 Subject: [PATCH] --- docs.mdwn | 46 +++++++++++++--------------------------------- 1 file changed, 13 insertions(+), 33 deletions(-) diff --git a/docs.mdwn b/docs.mdwn index 8b3147aee..16ea0e58c 100644 --- a/docs.mdwn +++ b/docs.mdwn @@ -3,7 +3,7 @@ A draft version of the specification is available at -## Codebase Structure +# Codebase Structure The SOC is partitioned into four repositories. The subrepositories are intended as general purpose standalone projects useful outside of LibreSOC. For example, @@ -17,10 +17,7 @@ construction of FSMs and arbitrary length pipelines. | [nmutil](https://git.libre-soc.org/?p=nmutil.git;a=tree) | [nmutil](https://docs.libre-soc.org/nmutil/) | Equivalent to Chisel3.util | [libresoc-nmutil](https://pypi.org/project/libresoc-nmutil) | | [OpenPOWER ISA](https://git.libre-soc.org/?p=nmutil.git;a=tree) | [OpenPOWER ISA](https://docs.libre-soc.org/openpower-isa/) | Simulator, ISA spec compiler, co-simulation infrastructure | [libresoc-openpower-isa](https://pypi.org/project/libresoc-openpower-isa/) | - -Also see [[SOC Architecture|3d_gpu/architecture]] - -## Installing the Codebase +# Installing the Codebase Installation is much easier when using the [install scripts](https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=hdl-dev-repos;hb=HEAD). @@ -37,40 +34,23 @@ For a simple set of commands to follow, see [[HDL_workflow/devscripts]]. If you prefer to do a manual install and explicitly install dependencies yourself, in order to verify them, see [[HDL_workflow]] -## Gtkwave Tutorial - -[[docs/gtkwave_tutorial]] - -## Formal proof notes - -[[docs/notes_on_formal_proofs]] - -## Learning nmigen - -[[docs/learning_nmigen]] - -## Test API - -[[docs/testapi]] - -## Pinmux and JTAG Boundary Scan - -[[docs/pinmux]] - -## pypowersim python-based command-line simulator - -[[docs/pypowersim]] - -## First steps +# Tutorials and documentation -[[docs/firststeps]] +* [[SOC Architecture|3d_gpu/architecture]] +* Gtkwave Tutorial [[docs/gtkwave_tutorial]] +* Formal proof notes [[docs/notes_on_formal_proofs]] +* Learning nmigen [[docs/learning_nmigen]] +* Test API [[docs/testapi]] +* Pinmux and JTAG Boundary Scan [[docs/pinmux]] +* pypowersim python-based command-line simulator [[docs/pypowersim]] +* First steps [[docs/firststeps]] -## SVP64 +# SVP64 Currently in Draft form, [[openpower/sv/svp64]] is the basis of the Supercomputing Cray-style Vectorisation of the Power ISA. -## Checklist for adding an instruction +# Checklist for adding an instruction TODO. use the commit diffs for these instructions as a guide -- 2.30.2