maci0/documentation

Read the docs !

RISC-V Documentation at RV-MACHINES

URLs :

• risc-v-machines.readthedocs.io
• risc-v-machines.rtfd.io
• 

Introduction

This is the repository for the documentation available at RISC-V Machines @ RTFD, a project that aims to serve documentation regarding the RISC-V architecture applied to containers and especially Kubernetes.

The documentation is hosted with love at Read The Docs.

For details about RISC-V itself, see the RISC-V Website and the RISC-V Getting Started Guide.

Compiling the Guide

The Guide is built using MkDocs.

MkDocs and project requirements can be installed using pip :

pip install mkdocs
pip install -r requirements.txt

for detailed instructions, see MkDocs User Guide

To compile the HTML version of the Guide, use::

mkdocs serve

It will start a light http server that will allow you viewing the rendered docs.