≥v≥v River Dreams ≥v≥v

❡ About

A tribal ZSH shell theme to help you craft your ambitious software projects. It is available for macOS and Linux.

Caption: a preview of the River Dreams theme with the Flamerial palette.

❡ 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.
• Install the theme using cargo. In case of an error, check cargo's output for troubleshooting.

cargo install river_dreams;

• Initiate the theme in ~/.zshrc:

echo 'eval $(river_dreams init);' >> ~/.zshrc;

• Reopen the shell.

❡ Help

If you need help related to this project, open a new issue in its issues pages or send 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 via 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.