Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skippyr/checkmate
A theme for the zsh shell for Linux that is decorated by chess pieces.
https://github.com/skippyr/checkmate
cli command-line design linux oh-my-zsh-theme productivity prompt script shell shell-script shell-theme terminal theme zsh zsh-script zsh-theme
Last synced: 3 days ago
JSON representation
A theme for the zsh shell for Linux that is decorated by chess pieces.
- Host: GitHub
- URL: https://github.com/skippyr/checkmate
- Owner: skippyr
- License: mit
- Created: 2023-06-19T17:00:31.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-09T17:22:14.000Z (10 months ago)
- Last Synced: 2024-04-16T17:24:36.126Z (9 months ago)
- Topics: cli, command-line, design, linux, oh-my-zsh-theme, productivity, prompt, script, shell, shell-script, shell-theme, terminal, theme, zsh, zsh-script, zsh-theme
- Language: Shell
- Homepage:
- Size: 2.17 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
≥v≥v checkmate ≥v≥v
## ❡ About
A theme for the `zsh` shell for Linux that is decorated by chess pieces.
Caption: a preview of checkmate applied on zsh. The terminal theme used is Flamerial and font is Fira Mono (Nerd Fonts patched).
### 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 the active Python virtual environment, if you have sourced one.
- The path of the directory you are in with parent directory names abbreviated by their initials.
- The active branch and if it is dirty, when inside of a `git` repository.
## ❡ Install
### Dependencies
The following dependencies must be installed before installing it:
- **git**: it will be used to clone this repository.
- **Noto Sans**, [**Nerd Font Symbols**](https://www.nerdfonts.com/font-downloads): these fonts provide the pretty symbols used by 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`:
```sh
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:
```zsh
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`](https://github.com/ohmyzsh/ohmyzsh) framework, using a terminal, follow these steps:
- Clone this repository using `git`:
```sh
git clone --depth 1 "https://github.com/skippyr/checkmate" \
"${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/checkmate";
```
- Apply the theme in your `~/.zshrc` configuration file by setting the `ZSH_THEME` variable:
```zsh
ZSH_THEME="checkmate/checkmate";
```
- Reopen `zsh`.
#### Procedures For Antidote
If you want to install this theme with the [`antidote`](https://github.com/mattmc3/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.
```zsh
antidote load "~/.zsh_plugins.txt";
```
## ❡ Help
If you need help related to this project, open a new issue in its [issues pages](https://github.com/skippyr/checkmate/issues) or send me an [e-mail](mailto:[email protected]) 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](https://github.com/skippyr/checkmate/pulls) or to my [e-mail](mailto:[email protected]).
By contributing to this project, you agree to license your work under the same license that the project uses.
## ❡ License
This is free software licensed under the MIT License that comes WITH NO WARRANTY. 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