fix a few README typos
This commit is contained in:
10
README.md
10
README.md
@@ -232,7 +232,7 @@ uv tool install monobiome
|
|||||||
pipx install monobiome
|
pipx install monobiome
|
||||||
```
|
```
|
||||||
|
|
||||||
The `monobiome` has provides three subcommands:
|
`monobiome` provides three subcommands:
|
||||||
|
|
||||||
- `monobiome palette`: generate palette files from raw parameterized curves
|
- `monobiome palette`: generate palette files from raw parameterized curves
|
||||||
|
|
||||||
@@ -295,6 +295,14 @@ The `monobiome` has provides three subcommands:
|
|||||||
output file to write filled template
|
output file to write filled template
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Config management
|
||||||
|
The `monobiome` CLI tool attempts to provide the minimal functionality needed
|
||||||
|
to produce customized themes for individual applications. If seeking a more
|
||||||
|
holistic, system-wide approach, you might consider using [`symconf`][3], a
|
||||||
|
general-purpose application config manager. `symconf` provides the templating
|
||||||
|
subsystem used for `monobiome` internals, and can be configured to apply live
|
||||||
|
theme updates to many apps with a single command line invocation.
|
||||||
|
|
||||||
|
|
||||||
[1]: https://github.com/isa/TextMate-Themes/blob/master/monoindustrial.tmTheme
|
[1]: https://github.com/isa/TextMate-Themes/blob/master/monoindustrial.tmTheme
|
||||||
[2]: https://addons.mozilla.org/en-US/firefox/collections/18495484/monobiome/
|
[2]: https://addons.mozilla.org/en-US/firefox/collections/18495484/monobiome/
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
type=str,
|
type=str,
|
||||||
default="hex",
|
default="hex",
|
||||||
choices=["hex", "oklch"],
|
choices=["hex", "oklch"],
|
||||||
help="Color notation to export (either hex or oklch)",
|
help="color notation to export (either hex or oklch)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-f",
|
"-f",
|
||||||
@@ -25,13 +25,13 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
type=str,
|
type=str,
|
||||||
default="toml",
|
default="toml",
|
||||||
choices=["json", "toml"],
|
choices=["json", "toml"],
|
||||||
help="Format of palette file (either JSON or TOML)",
|
help="format of palette file (either JSON or TOML)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-o",
|
"-o",
|
||||||
"--output",
|
"--output",
|
||||||
type=str,
|
type=str,
|
||||||
help="Output file to write palette content",
|
help="output file to write palette content",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.set_defaults(func=handle_palette)
|
parser.set_defaults(func=handle_palette)
|
||||||
|
|||||||
@@ -16,13 +16,13 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
"mode",
|
"mode",
|
||||||
type=str,
|
type=str,
|
||||||
choices=["dark", "light"],
|
choices=["dark", "light"],
|
||||||
help="Scheme mode (light or dark)"
|
help="scheme mode (light or dark)"
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"biome",
|
"biome",
|
||||||
type=str,
|
type=str,
|
||||||
choices=list(monotone_h_map.keys()),
|
choices=list(monotone_h_map.keys()),
|
||||||
help="Biome setting for scheme."
|
help="biome setting for scheme"
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-m",
|
"-m",
|
||||||
@@ -30,7 +30,7 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
type=str,
|
type=str,
|
||||||
default="oklch",
|
default="oklch",
|
||||||
choices=["wcag", "oklch", "lightness"],
|
choices=["wcag", "oklch", "lightness"],
|
||||||
help="Metric to use for measuring swatch distances."
|
help="metric to use for measuring swatch distances"
|
||||||
)
|
)
|
||||||
|
|
||||||
# e.g., wcag=4.5; oklch=0.40; lightness=40
|
# e.g., wcag=4.5; oklch=0.40; lightness=40
|
||||||
@@ -39,13 +39,13 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
"--distance",
|
"--distance",
|
||||||
type=float,
|
type=float,
|
||||||
default=0.40,
|
default=0.40,
|
||||||
help="Distance threshold for specified metric",
|
help="distance threshold for specified metric",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-o",
|
"-o",
|
||||||
"--output",
|
"--output",
|
||||||
type=str,
|
type=str,
|
||||||
help="Output file to write scheme content",
|
help="output file to write scheme content",
|
||||||
)
|
)
|
||||||
|
|
||||||
# these params remain rooted in lightness; no need to accommodate metric
|
# these params remain rooted in lightness; no need to accommodate metric
|
||||||
@@ -58,13 +58,13 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
"--l-base",
|
"--l-base",
|
||||||
type=int,
|
type=int,
|
||||||
default=20,
|
default=20,
|
||||||
help="Minimum lightness level (default: 20)",
|
help="minimum lightness level (default: 20)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--l-step",
|
"--l-step",
|
||||||
type=int,
|
type=int,
|
||||||
default=5,
|
default=5,
|
||||||
help="Lightness step size (default: 5)",
|
help="lightness step size (default: 5)",
|
||||||
)
|
)
|
||||||
|
|
||||||
# gaps
|
# gaps
|
||||||
@@ -72,19 +72,19 @@ def register_parser(subparsers: _SubparserType) -> None:
|
|||||||
"--fg-gap",
|
"--fg-gap",
|
||||||
type=int,
|
type=int,
|
||||||
default=50,
|
default=50,
|
||||||
help="Foreground lightness gap (default: 50)",
|
help="foreground lightness gap (default: 50)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--grey-gap",
|
"--grey-gap",
|
||||||
type=int,
|
type=int,
|
||||||
default=30,
|
default=30,
|
||||||
help="Grey lightness gap (default: 30)",
|
help="grey lightness gap (default: 30)",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--term-fg-gap",
|
"--term-fg-gap",
|
||||||
type=int,
|
type=int,
|
||||||
default=65,
|
default=65,
|
||||||
help="Terminal foreground lightness gap (default: 60)",
|
help="terminal foreground lightness gap (default: 60)",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.set_defaults(func=handle_scheme)
|
parser.set_defaults(func=handle_scheme)
|
||||||
|
|||||||
Reference in New Issue
Block a user