Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skippyr/chinatown

A powerline theme for the zsh shell for Linux that is decorated by a dragon and flames.
https://github.com/skippyr/chinatown

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: 15 days ago
JSON representation

A powerline theme for the zsh shell for Linux that is decorated by a dragon and flames.

Awesome Lists containing this project

README

        




≥v≥v chinatown ≥v≥v




 

 

 

## ❡ About

A powerline theme for the `zsh` shell for Linux that is decorated by a dragon and flames.




Caption: a preview of chinatown applied on zsh. The terminal theme used is Flamerial and font is Fira Mono (Nerd Fonts patched).

### Features

It displays:

- If your last command failed, as the dragon would spit fire.
- Your host and user names.
- 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 the latest tag, 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/chinatown";
```

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

```zsh
source "~/.config/zsh/themes/chinatown/chinatown.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/chinatown" \
"${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/chinatown";
```

- Apply the theme in your `~/.zshrc` configuration file by setting the `ZSH_THEME` variable:

```zsh
ZSH_THEME="chinatown/chinatown";
```

- 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/chinatown
```

- 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/chinatown/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/chinatown/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