Skip to content

Latest commit

 

History

History
151 lines (104 loc) · 7.73 KB

README.md

File metadata and controls

151 lines (104 loc) · 7.73 KB
Raw

≥v≥v river-dreams ≥v≥v

     

❡ About

A fast and full-featured tribal looking shell theme available for Windows (PowerShell), Linux (ZSH) and MacOS (ZSH). It is designed to help you develop even your most ambitious software projects.

Caption: River Dreams running on MacOS (ZSH). Terminal theme is Flamerial. Font is Hack (patched by the Nerd Fonts project).

Note

The font and colors used in the software may be affected by your terminal settings. Images for illustration purpose only.

Features

These are the descriptions of each prompt feature from left to right, top to bottom, respectively:

Left Prompt Features

  • Your local IPV4 address or "No Address" if no address can be found.
  • If you are using a laptop, its battery charge and if it is being currently charged.
  • Your disk usage.
  • A calendar showing the week day, month and day.
  • A 24-hours clock with a symbol that changes depending on the day time: dawn (between 00h00m to 06h00m), morning (between 06h00m and 12h00m), afternoon (between 12h00m and 18h00m) and night (between 18h00m and 00h00m).
  • A hash symbol when you have administrator privileges, on Windows, or is the root user on MacOS and Linux.
  • The exit code of the last command ran.
  • The active Python virtual environment, if you have sourced one.
  • The current active directory path, shorting it when inside of a Git repository.
  • The active branch, when inside of a Git repository.

Right Prompt Features

  • The total of each entry type in the current active directory: block devices, character devices, directories, fifos, files, hidden entries, sockets, symlinks and temporary entries. Symlinks are followed. Types availability and interpretation are subject to the operating system you are using.

❡ Install

Dependencies

The following dependencies must be installed before it:

Dependencies For Windows

  • Visual Studio 2022 with the "Desktop development with C++" workload: it provides all the tools required to build this software.
  • Git: it will be used to clone this repository.
  • A font patched by the Nerd Fonts project: it provides the pretty symbols used by the software.

Warning

It is highly recommended that you use a terminal with great Unicode and wide-character support for the symbols used in the theme to appear correctly. Recommendation for Windows is Windows Terminal. It comes pre-installed on Windows 11, while on Windows 10 you can download it from the Microsoft Store.

Dependencies For Linux

  • GCC, CMake: they will be used to build this software.
  • Git: it will be used to clone this repository.
  • A font patched by the Nerd Fonts project: it provides the pretty symbols used by the software.

Tip

Use your distro package manager to install these packages.

Warning

It is highly recommended that you use a terminal with great Unicode and wide-character support for the symbols used in the theme to appear correctly. Recommendation for Linux is Kitty. You can download it by following the previous tip.

Dependencies For MacOS

  • Apple Command Line Tools, cmake: they will be used to build this software.
  • Git: it will be used to clone this repository.
  • A font patched by the Nerd Fonts project: it provides the pretty symbols used by the software.

Tip

Use xcode-select --install to install the Apple command line tools. For the rest, use HomeBrew.

Warning

It is highly recommended that you use a terminal with great Unicode and wide-character support for the symbols used in the theme to appear correctly. Recommendation for MacOS is Kitty. You can download it by following the previous tip.

Procedures

Procedures For Windows

  • Open PowerShell with administrator priveleges.
  • Set your PowerShell execution policy to Bypass. When prompted, type y to accept the changes. This will allow you to execute River Dreams, as, by default, Windows does not allow the execution of any script or configuration file. For more information, access the PowerShell Execution Policy documentation page:
Set-ExecutionPolicy Bypass;
  • Reopen PowerShell without administrator priveleges.
  • Clone this repository using git:
git clone --depth 1 https://github.com/skippyr/river-dreams `
          "${env:USERPROFILE}\powershell\themes\river-dreams";
  • Add the specific connector to the PowerShell profile file:
Write-Output `n'. "${env:USERPROFILE}\powershell\themes\river-dreams\src\connectors\river-dreams.ps1";' | `
Out-File -Append -Encoding UTF8 ${PROFILE};
  • Reopen PowerShell in order to initiate the theme.
  • During its first execution, River Dreams will automatically check its dependencies and build its source code, a process that can take a moment. Once that is done, the theme will be loaded and will be ready for you to use.

Procedures For Linux and MacOS

  • Open ZSH.
  • Clone this repository using git:
git clone --depth 1 https://github.com/skippyr/river-dreams \
          ~/.local/share/zsh/themes/river-dreams;
  • Add the specific connector to the ZSH profile file:
echo "source ~/.local/share/zsh/themes/river-dreams/src/connectors/river-dreams.zsh;" >> ~/.zshrc;
  • Reopen ZSH in order to initiate the theme.
  • During its first execution, River Dreams will automatically check its dependencies and build its source code, a process that can take a moment. Once that is done, the theme will be loaded and will be ready for you to use.

❡ 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, 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.

❡ 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.

 

Birth: February 20th 2023.

≥v≥v Here Be Dragons! ≥v≥
Made with love by skippyr <3