A tribal looking theme for the zsh shell for Linux.

^{Caption: a preview of riverdreams applied on zsh. The terminal theme used is flamerial and font is iosevka ss08.}

Its left prompt displays:

• Your local IPV4 address.
• Your disk usage.
• Your battery charge, if any.
• A calendar.
• A clock.
• A decorator when you are the root user.
• The exit code of the last command you typed in.
• The active mode of the zsh-vi-mode plugin, if it has been sourced.
• The active Python virtual environment, if you have sourced one.
• The active directory path, shorting it when inside of a git repository.
• The active branch, when inside of a git repository.
• A decorator when you do not have access to the active directory.

Its right prompt displays:

• The total of each entry type and some statuses in the active directory: regulars, directories, blocks, characters, sockets, fifos, symlinks, hidden and temporary entries.
• The total of background jobs.

The following dependencies must be installed before installing it:

• git: it will be used to clone this repository.
• gcc, make: they will be used to compile this software.
• Noto Sans, Nerd Font Symbols: these fonts provide the pretty symbols used in the software.

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

• Clone this repository using git:

git clone --depth 1 https://github.com/skippyr/riverdreams \
                    ~/.config/zsh/themes/riverdreams;

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

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

• Open a new zsh session.
• Wait for the theme to compile.

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

• Clone this repository using git:

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

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

ZSH_THEME=riverdreams/riverdreams;

• Open a new zsh session.
• Wait for the theme to compile.

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

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

skippyr/riverdreams

• Use antidote to load your plugins.

antidote load ~/.zsh_plugins.txt;

• Wait for the theme to compile.

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.

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.

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}