≥v≥v checkmate ≥v≥v

❡ About

A theme for the ZSH shell that is decorated by chess pieces.

^{Caption: a preview of checkmate applied on zsh. The terminal theme used is Flamerial and font is Fira Code.}

Features

It displays:

If you are the root user, as the pawn will become a queen.
The exit code of failed commands.
The name of sourced Python virtual environments.
The path of the directory you are in, abbreviating parent directory names by their initials.
When inside of a Git repository, the active branch and if it is dirty.

❡ Install

Dependencies

The following dependencies must be installed before installing it:

git: it will be used to clone this repository.
Nerd Font Symbols: this font provides the pretty symbols used in the theme.

Procedures

Manual Procedures

If you want to install this theme without a plugin manager or for a specific framework, using a terminal, follow these steps:

Clone this repository using git:

git clone --depth 1 ~/.config/zsh/themes/checkmate;

Source the file checkmate.zsh-theme that is inside of the repository you just cloned in your ~/.zshrc configuration file:

source ~/.config/zsh/themes/checkmate/checkmate.zsh-theme;

Reopen zsh.

Procedures For OhMyZSH

If you want to install and use this theme with the ohmyzsh framework, using a terminal, follow these steps:

Clone this repository using git:

git clone --depth 1 https://github.com/skippyr/checkmate \
                    ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/checkmate;

Apply the theme in ~/.zshrc configuration by setting the ZSH_THEME variable:

ZSH_THEME=checkmate/checkmate;

Reopen zsh.

Procedures For Antidote

If you want to install this theme with the antidote plugin manager, using a terminal, follow these steps:

Add this repository to your plugins file, usually ~/.zsh_plugins.txt.

skippyr/checkmate

Use antidote to load your plugins.

antidote load ~/.zsh_plugins.txt;

❡ Help

If you need help related to this project, open a new issue in its issues pages or send me an e-mail describing what is going on.

❡ Contributing

This project is open to review and possibly accept contributions, specially fixes and suggestions. If you are interested, send your contribution to its pull requests page or to my e-mail.

By contributing to this project, you agree to license your work under the same license that the project uses.

❡ License

This project is licensed under the MIT License. Refer to the LICENSE file that comes in its source code for license and copyright details.

^{≥v≥v Here Be Dragons! ≥v≥
Made with love by skippyr <3}