≥v≥v River Dreams ≥v≥v

❡ About

River Dreams is a tribal looking theme for the ZSH shell made to help you craft your most ambitious software projects. It is available for macOS and Linux.

Caption: a preview of the River Dreams theme.

Prompts & Modules

The theme is composed of two prompts, one in the left and other in the right. Each prompt has modules that provides its features. From left to right, top to bottom, those are:

Left Prompt Modules

The left prompt prompt modules are:

• IP Address Module: displays the IP address of the computer.
• Battery Module: which, in case of a laptop, displays the information about the charge of the battery of the computer, including its percentage and status.
• Disk Module: which displays the information about the usage of the main disk of the computer, including its percentage and status.
• Calendar Module: which displays a calendar showing the week day, month, and day of month.
• Clock Module: which display a 24-hours clock with a symbol that changes accordingly to the day fraction.
• Root Module: which displays a hash symbol when the user is root.
• Exit Code Module: which displays the exit code of the last command inserted in the shell.
• Virtual Env Module: which displays the active Python virtual environment sourced.
• Path Module: which displays the current directory path, abbreviating it when inside of Git repositories.
• Git Module: which displays information about an active repository, including the active reference branch name or hash and a ballot X symbol when there are changes to be commited.
• Directory Access Module: which displays a lock symbol whenever the user can not write to the current directory.

Right Prompt Modules

The right prompt prompt modules are:

• Directory Summary Module: which displays the total number of each entry type in the current directory.
• Jobs Module: which displays the total number of background jobs running in the shell.

❡ Install

Dependencies

The following dependencies must be installed before it:

• Rust Toolchain: it will be used to build the project.
• A font patched by the Nerd Fonts project: it provides the pretty symbols used by the software.

Use your OS package manager or HomeBrew to install these packages.

It is also recommended to use a terminal with great Unicode support avoid installing multiple Nerd Fonts for the symbols used in the theme to appear correctly. The terminal recommended is Kitty. You can download it by following the previous tip.

Procedures

• Apply the Nerd Font installed in your terminal and reopen it.
• Install the theme using cargo. In case of an error, check cargo's output for troubleshooting. Reopen your shell to retry compilation:

cargo install river_dreams;

• Add its connector to your zsh configuration file.

river_dreams --connector >> ~/.zshrc;

• Reopen your shell.

❡ Help

For quick instructions about the usage of the software, refer to its help page:

river_dreams --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 in the form of bug reports and suggestions. If you are interested, send your contribution to its pull requests page or to my e-mail.

❡ License

This is free software licensed under the BSD-3-Clause 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}