Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.81 KB

CONTRIBUTING_TO_TEMPLATES.md

File metadata and controls

73 lines (55 loc) · 2.81 KB
Raw

Contributing to Template Repsitories

Tinted Theming template repository includes a GitHub Action that builds the colorschemes once a week. This keeps the template up-to-date with the tinted-schemes repository automatically.

Building

tinted-builder-rust is recommended to build template repositories. It's not required to be in any specific directory when building a template because the build subcommand accepts absolute or relative paths as arguments. To build the current working directory tinted-builder-rust build . can be run.

Dependencies

The following is the dependency list for building themes of a tinted-theming template repository:

Usage for template editing

  1. Install tinted-builder-rust
  2. tinted-builder-rust build path/to/your/tinted-template-repository

Note: path/to/your/tinted-template-repository is a placeholder path and should reflect the absolute or relative path to your local template repository you want to build.

Usage for adding or editing a colorscheme

  1. Clone the tinted-template-repository locally, eg: tinted-tmux

  2. Clone tinted-schemes locally

  3. Install tinted-builder-rust

  4. Execute:

    tinted-builder-rust build /path/to/tinted-tmux --schemes-dir /path/to/tinted-schemes

    Note: path/to/tinted-tmux and path/to/tinted-schemes are placeholders and should reflect the absolute or relative paths to your local template and schemes repositories.

Command Breakdown

A basic breakdown of the command used in the execute step above:

  1. tinted-builder-rust - The CLI tool tinted-builder-rust
  2. build - The build subcommand. This accepts 1 absolute or relative path to template repository argument.
  3. /path/to/tinted-template-repository - The argument that the build subcommand accepts. This is the absolute or relative path to the template repository to build or generate themes for.
  4. --schemes-dir - A CLI flag which specifies that a custom schemes repository should be used instead of cloning and using the latest tinted-schemes repository.
  5. /path/to/your/schemes-repo - The path value associated with the --schemes-dir CLI flag.

Run tinted-builder-rust --help to explore more options and subcommands. For more details refer to tinted-builder-rust README.md, or open an issue on GitHub.