From 7fd9f313eeee511e7c3bcaaf0ec35ef67cc65952 Mon Sep 17 00:00:00 2001 From: evilchili Date: Sun, 31 Jul 2022 15:07:39 -0700 Subject: [PATCH] README.md update --- README.md | 42 ++++++------------------------------------ 1 file changed, 6 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 7b48ef2..c4dfdef 100644 --- a/README.md +++ b/README.md @@ -4,44 +4,14 @@ RollTables is a python library for generating tables suitable for selecting rand ## Quick Start +Clone the repo and install the virtual env: +``` +% git clone https://github.com/evilchili/dnd-rolltable +% cd dnd-rolltable +% poetry install ``` -# example.yaml -# metadata is optional -metadata: - # headers are optional - headers: - # The first column header always applies to the frequency label; - # you can hide this (or any other column) by setting the header to null - - Rarity - - Color - - Notes - # frequencies are optional; by default distribution will be uniform - frequencies: - # multiple distributions may be specified besides 'default' - default: - - common: 0.5 - - uncommon: 0.3 - - rare: 0.15 - - wondrous: 0.05 -# 'common' is the text label for the frequency distribution -common: - # each time a 'common' value is selected for the table, it will be - # chosen at random from the following values - - red - - orange - - yellow -uncommon: - - green - - blue -rare: - - indigo - - violet -wondrous: - # choices can be definitions; both key and the value will be added as columns - - octarine: the color of magic -``` - +Invoke the CLI: ``` % poetry run roll-table example.yaml ┏━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓