Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skippyr/river-dreams
A tribal inspired ZSH theme for Linux.
https://github.com/skippyr/river-dreams
c linux oh-my-zsh-theme scripting shell shell-scripting shell-theme terminal zsh zsh-scripting zsh-theme
Last synced: 2 months ago
JSON representation
A tribal inspired ZSH theme for Linux.
- Host: GitHub
- URL: https://github.com/skippyr/river-dreams
- Owner: skippyr
- License: mit
- Created: 2023-02-20T21:24:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-12T23:32:44.000Z (2 months ago)
- Last Synced: 2024-03-13T18:26:46.965Z (2 months ago)
- Topics: c, linux, oh-my-zsh-theme, scripting, shell, shell-scripting, shell-theme, terminal, zsh, zsh-scripting, zsh-theme
- Language: C
- Homepage:
- Size: 20.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - river-dreams - Includes decorators for `git` information, machine's IP address, time, disk usage on `/`, current Python `venv`, current directory, root status, and the last command's exit status. (Themes / ZSH on Windows)
- fucking-awesome-zsh-plugins - river-dreams - Includes decorators for `git` information, machine's IP address, time, disk usage on `/`, current Python `venv`, current directory, root status, and the last command's exit status. (Themes / ZSH on Windows)
README
≥v≥v river-dreams ≥v≥v
## ❡ About
A tribal inspired ZSH theme for Linux designed to help you develop your dream projects.
It includes many features that inform you about your environment, making it a great addition for any desktop setup, specially minimalist tiling window managers.
Caption: a preview of River Dreams applied on ZSH. The terminal theme used is Flamerial and font is Iosevka SS08.
### Features
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 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 in the active directory: regulars, directories, blocks, characters, sockets, fifos and symlinks.
- The total of background jobs.
## ❡ Install
### Dependencies
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 theme.
- [**Nerd Font Symbols**](https://www.nerdfonts.com/font-downloads), **Noto Sans**: they provide the pretty symbols used in the theme.
### Procedures
#### Manual Procedures
If you want to install this theme without a plugin manager or for a specific framework, follow these steps:
- Clone this repository using `git`:
```sh
git clone --depth 1 ~/.config/zsh/themes/river-dreams;
```
- Source the file `river-dreams.zsh-theme` that is inside of the repository you just cloned in your `~/.zshrc` configuration file:
```zsh
source ~/.config/zsh/themes/river-dreams/river-dreams.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, follow these steps:
- Clone this repository using `git`:
```sh
git clone --depth 1 https://github.com/skippyr/river-dreams\
${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/river-dreams;
```
- Apply the theme in `~/.zshrc` configuration by setting the `ZSH_THEME` variable:
```zsh
ZSH_THEME="river-dreams/river-dreams";
```
- Reopen `zsh`.
#### Procedures For Antidote
If you want to install this theme with the [`antidote`](https://github.com/mattmc3/antidote) plugin manager, follow these steps:
- Add this repository to your plugins file, usually `~/.zsh_plugins.txt`.
```
skippyr/river-dreams
```
- 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/river-dreams/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/river-dreams/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 project is licensed under the MIT License. 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