minor fixes to README.md

This commit is contained in:
Louis Heredero 2024-04-12 22:07:48 +02:00
parent b6e9c6f4db
commit 30339f0ece
Signed by: HEL
GPG Key ID: 8D83DE470F8544E7
2 changed files with 25 additions and 2 deletions

View File

@ -1,4 +1,20 @@
### rivet - Register / Instruction Visualizer and Explainer Tool <h3>rivet - Register / Instruction Visualizer and Explainer Tool</h3>
---
## Table of contents
<!-- TOC -->
* [Table of contents](#table-of-contents)
* [Introduction](#introduction)
* [Requirements](#requirements)
* [Usage](#usage)
* [Options](#options)
* [Examples](#examples)
* [config.json](#configjson)
* [dark.json](#darkjson)
* [blueprint.json](#blueprintjson)
* [transparent.json](#transparentjson)
* [Config](#config)
<!-- TOC -->
--- ---
@ -156,4 +172,10 @@ The config file may change the following values to customize the layout and styl
- `forceDescsOnSide`: if true, descriptions are placed on the side of the register, otherwise, they are placed as close as possible to the bit - `forceDescsOnSide`: if true, descriptions are placed on the side of the register, otherwise, they are placed as close as possible to the bit
- `leftLabels`: if true, descriptions are put on the left, otherwise, they default to the right hand side - `leftLabels`: if true, descriptions are put on the left, otherwise, they default to the right hand side
- `width`: the image width (in pixels) - `width`: the image width (in pixels)
- `height`: the image height (in pixels) - `height`: the image height (in pixels)
Some config examples are already included:
- [config.json](config.json): Default configuration values (black on white)
- [dark.json](dark.json): Dark theme (white on black)
- [blueprint.json](blueprint.json): Blueprint theme (white on blue)
- [transparent.json](transparent.json): Transparent background, for easy integration in other documents (grey on transparent)

View File

@ -19,6 +19,7 @@
"valuesGap": 5, "valuesGap": 5,
"arrowLabelDistance": 5, "arrowLabelDistance": 5,
"forceDescsOnSide": false, "forceDescsOnSide": false,
"leftLabels": false,
"width": 1200, "width": 1200,
"height": 800 "height": 800
} }