Skip to content

Commit

Permalink
docs: fix typos (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
henry-hsieh authored Apr 26, 2024
1 parent 3a0bb45 commit b5df9a3
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,9 @@ Some subcommands support additional flags and options to modify their behavior:

| Flag/Option | Description | Applicable Subcommands | Default Value | Example Usage |
|-------------------|-----------------------------------------|------------------------|---------------|-------------------------------------------|
| `--config` `-c` | Specifies a custom configuration file path. | All | If not provided tinty looks for `config.toml` at `$XDG_CONFIG_HOME/tinty/config.toml` otherwise `~/.tinty/config.toml` | `tinty apply base16-ayu-dark --config /path/to/custom/config.toml` |
| `--data-dir` | Specifies a custom path for the data directory. | All | If not provided tinty looks for the data directory at `$XDG_DATA_HOME/tinted-theming/tinty` otherwise `~/.local/share` | `tinty install --data-dir /path/to/custom/data-dir` |
| `--help` `-h` | Displays help information for the subcommand. | All | - | `tinty --help`, `tinty apply --help`, etc |
| `--config` `-c` | Specifies a custom configuration file path. | All | If not provided tinty looks for `config.toml` at `$XDG_CONFIG_HOME/tinty/config.toml` otherwise `~/.config/tinty/config.toml` | `tinty apply base16-ayu-dark --config /path/to/custom/config.toml` |
| `--data-dir` | Specifies a custom path for the data directory. | All | If not provided tinty looks for the data directory at `$XDG_DATA_HOME/tinted-theming/tinty` otherwise `~/.local/share/tinted-theming/tinty` | `tinty install --data-dir /path/to/custom/data-dir` |
| `--help` `-h` | Displays help information for the subcommand. | All | - | `tinty --help`, `tinty apply --help`, etc. |
| `--version` `-V` | Shows the version of tinty. | All | - | `tinty --version` |

## Configuration
Expand All @@ -193,12 +193,12 @@ to your preferences and environment.
| `shell` | `string` | Optional | Specifies the shell command used to execute hooks. | `"sh -c '{}'"` | `shell = "bash -c '{}'"` |
| `default_scheme` | `string` | Optional | Defines the default theme scheme to be applied if no specific scheme is set. | None | `default_scheme = "base16-mocha"` |
| `hooks` | `array<string>` | Optional | A list of strings which are executed after every `tinty apply` | None | `hooks = ["echo \"The current scheme is: $(tinty current)\""]` |
| `[[items]]` | `array<items>` | Required | An array of `items` configurations. Each item represents a themable component. Detailed structure provided in the next section. | - | - |
| `[[items]]` | `array<items>` | Required | An array of `items` configurations. Each item represents a themeable component. Detailed structure provided in the next section. | - | - |

### Items table `config.toml` Schema

The `[[items]]` section within `config.toml` allows for detailed
customization of individual themable components. Each item represents a
customization of individual themeable components. Each item represents a
specific element you can theme, such as a text editor or terminal. The
table below outlines the structure for these items, including how to
specify templates, directories for theme files, and hooks for applying
Expand All @@ -221,7 +221,7 @@ options are `"base16"` and `"base24"`, indicating support for [Base16]
and [Base24] theming systems, respectively. If the template repository
does not support a system, it should not be included in this property.

The `[[items]]` configuration allows defining multiple themable
The `[[items]]` configuration allows defining multiple themeable
components, each with its own set of configurations as described above.
Here's how you might define multiple items in your `config.toml`:

Expand Down Expand Up @@ -268,7 +268,7 @@ tinty apply $(tinty list | fzf)
### Migration from Flavours

[Flavours] is a great base16 manager written in Rust and it's where
Tinty has gotten a lot of it's inspiration. Flavours isn't actively
Tinty has gotten a lot of its inspiration. Flavours isn't actively
maintained anymore and that's the reason I continued to build and
develop Tinty.

Expand Down
17 changes: 8 additions & 9 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ applied through Tinty, this file is updated.
1. `tinty apply` sets `current_scheme`.
1. It then runs through the `[[items]]` in your `config.toml
1. For each `[[items]]`, or theme template, it copies the relevant theme
to `~/.local/shared/tinted-theming/tinty` and executes the the `hook`
to `~/.local/shared/tinted-theming/tinty` and executes the `hook`
property of the `[[items]]`. `%f` is a template variable that can be
used in the hook, eg: `hook = "cp -f %f
used in the hook, e.g., `hook = "cp -f %f
~/.config/alacritty/colors.yml`.

`tinty apply` can also be used without a theme template. The
Expand All @@ -49,7 +49,7 @@ lot with it.
General `config.toml` hooks can be used to source and execute scripts,
but due to the way shell sub-processes work, the scripts sourced by
Tinty can't set your current shell session's environment variables.
There is a work around for this specific issue.
There is a workaround for this specific issue.

1. Create a function which executes `tinty` with all the same arguments
2. Check for any `*.sh` files in the active Tinty themes directory
Expand Down Expand Up @@ -99,17 +99,16 @@ Add the following to your `config.toml`:

```toml
[[items]]
name = "vim"
path = "https://github.com/tinted-theming/tinted-shell"
name = "base16-shell"
themes-dir = "scripts"
hook = ". %f"
```

[tinted-shell] does set some environment variables in the script, but
it's not neccessary for shell styling. If you still want access to these
it's not necessary for shell styling. If you still want access to these
variables, you will need to execute the [tinted-shell] theme script in
your current shell session. Have a look at [Sourcing scripts that set
env vars](#sourcing-scripts-that-set-env-vars)
your current shell session. Have a look at [Sourcing scripts that set environment variables]

## Vim or Neovim

Expand Down Expand Up @@ -327,7 +326,7 @@ themes-dir = "sh"

**2. Source the fzf theme script files in your shell**

Have a look at [Sourcing scripts that set env vars] section. Once you've
Have a look at [Sourcing scripts that set environment variables] section. Once you've
implemented that, your fzf theme should be updating correctly when you
run `tinty init` or `tinty apply base16-mocha` or some other theme name.

Expand Down Expand Up @@ -370,4 +369,4 @@ alias bat="bat --theme='base16-256'"
[tinted-tmux]: https://github.com/tinted-theming/tinted-tmux
[tmux tpm]: https://github.com/tmux-plugins/tpm
[XDG Base Directory specification]: https://wiki.archlinux.org/title/XDG_Base_Directory
[Sourcing scripts that set env vars]: #sourcing-scripts-that-set-env-vars
[Sourcing scripts that set environment variables]: #sourcing-scripts-that-set-environment-variables

0 comments on commit b5df9a3

Please sign in to comment.