README.md

ABS Group Project Documentation

This repository contains an MkDocs book with documentation for various projects by ABS students and researchers in a more centralized way then semi-interlinked readmes.

Right now it contains documentation of:

• Tydi-spec
• Tydi-Chisel
• Tydi-Clash
• Tywaves
• ChiselSlicer (has no public repo yet)

Building the book

Install Material for MkDocs and Mkidocs-Macros using pip (possibly in a virtual environment for your convenience).

pip install mkdocs-material mkdocs-macros-plugin

Make sure the install location is in your path, then run

mkdocs serve

and access the book at http://127.0.0.1:8000/.