diff --git a/README.md b/README.md index 5b2d0a2..b84ca24 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ -### rivet - Register / Instruction Visualizer and Explainer Tool +

rivet - Register / Instruction Visualizer and Explainer Tool

+ +--- +## Table of contents + + * [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) + --- @@ -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 - `leftLabels`: if true, descriptions are put on the left, otherwise, they default to the right hand side - `width`: the image width (in pixels) -- `height`: the image height (in pixels) \ No newline at end of file +- `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) diff --git a/config.json b/config.json index 7bc4cda..3491bfe 100644 --- a/config.json +++ b/config.json @@ -19,6 +19,7 @@ "valuesGap": 5, "arrowLabelDistance": 5, "forceDescsOnSide": false, + "leftLabels": false, "width": 1200, "height": 800 } \ No newline at end of file