diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-09-01 17:37:24 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-09-01 17:37:24 -0400 |
| commit | 12345a85d9c7d7a56ddf323247a4bdf347021b73 (patch) | |
| tree | 93bafb42c1ec2c22cc2858936034901c39cbca82 /examples/colorful/README.md | |
| parent | c778c8822f1c8acf981e26f7b860a384c94cff6f (diff) | |
| parent | adc2d81b5683e611c5f3289be6157d4519a60632 (diff) | |
Merge branch 'main' into optional-list-indexing
Diffstat (limited to 'examples/colorful/README.md')
| -rw-r--r-- | examples/colorful/README.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/examples/colorful/README.md b/examples/colorful/README.md deleted file mode 100644 index faded9b1..00000000 --- a/examples/colorful/README.md +++ /dev/null @@ -1,70 +0,0 @@ -# Colorful Lang - -Colorful is a `lang` that lets you write colorful text for the terminal without -having to stress about managing state for color highlighting. - -## Grammar - -The grammar looks like this: - -``` -colorful <- ("@(at)" / "@(lparen)" / "@(rparen)" # Escapes - / "@(" attributes ":" colorful ")" # Colorful text - / .)* # Plain text - -attributes <- (attribute ("," attribute)*)? - -attribute <- color # Color defaults to foreground - / "fg=" color # Foreground color - / "bg=" color # Background color - / "ul=" color # Underline color - / "b" / "bold" - / "d" / "dim" - / "u" / "underline" - / "i" / "italic" - / "B" / "blink" - / "r" / "reverse" - # These are rarely supported by terminals: - / "fraktur" - / "frame" - / "encircle" - / "overline" - / "super" / "superscript" - / "sub" / "subscript" - -color <- "black" / "red" / "green" / "yellow" / "blue" / "magenta" / "cyan" / "white" - # All caps colors are "bright" colors (not always supported): - / "BLACK" / "RED" / "GREEN" / "YELLOW" / "BLUE" / "MAGENTA" / "CYAN" / "WHITE" - / "default" - / "#" 6 hex # Values 0x000000-0xFFFFFF - / "#" 3 hex # Values 0x000-0xFFF - / 1-3 digit # Values 0-255 -``` - -## Command Line Usage - -You can run `colorful` as a standalone executable to render colorful text with -ANSI escape sequences so it looks nice on a terminal. - -``` -colorful [--help] [texts...] [--by-line] [--files ...] -``` - -## Library Usage - -`colorful` can also be used as a Tomo library: - -```ini -# modules.ini -[colorful] -version=v1.0 -``` - -```tomo -use colorful - -$Colorful" - @(blue:Welcome to the @(bold:party)!) - We have @(green,bold:colors)! -".print() -``` |