From ca4161b18f909e8aaeb6474b9c88fd3feb4ea8af Mon Sep 17 00:00:00 2001 From: Antoine POPINEAU Date: Fri, 16 Aug 2024 13:02:41 +0200 Subject: [PATCH] Add mention of enclosing a style string within quotes to prevent bad shell interpretation. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7ea42c2..618e2a0 100644 --- a/README.md +++ b/README.md @@ -229,6 +229,8 @@ Optionally, a user can be selected from a menu instead of typing out their name, A theme specification can be given through the `--theme` argument to control some of the colors used to draw the UI. This specification string must have the following format: `component1=color;component2=color[;...]` where the component is one of the value listed in the table below, and the color is a valid ANSI color name as listed [here](https://github.com/ratatui-org/ratatui/blob/main/src/style/color.rs#L15). +Mind that the specification string include semicolons, which are command delimiters in most shells, hence, you should enclose it in single-quotes so it is considered a single argument instead. + Please note that we can only render colors as supported by the running terminal. In the case of the Linux virtual console, those colors might not look as good as one may think. Your mileage may vary. | Component name | Description |