From ac4cd5e0d45ed61b31c0edc9e9a2c638d341e67f Mon Sep 17 00:00:00 2001 From: dchakro <35454738+dchakro@users.noreply.github.com> Date: Sat, 5 Sep 2020 20:15:01 +0300 Subject: [PATCH] Update Readme --- README.md | 104 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 78 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 108450e..510587a 100644 --- a/README.md +++ b/README.md @@ -2,114 +2,166 @@ # alacritty colors -This repo contains snippets for color schemes to use with [alacritty](https://github.com/alacritty/alacritty) terminal emulator (and other similar apps). Most of these themes are (as-is or modified) from [alacritty's wiki](https://github.com/alacritty/alacritty/wiki/Color-schemes). +## About +This repo contains snippets for color schemes to use with [alacritty](https://github.com/alacritty/alacritty) terminal emulator (and other similar apps) and a bash script to [apply themes](./apply_themes.sh) and [show the current theme's colors](./show_colors.sh). -Also includes a handy bash script [`show_colors.sh`](./show_colors.sh) to print the colors. +## How to use -if you don’t want to clone this repo but still want to test the color scheme then you can run: +1. Clone the repo and give execute permissions to included scripts. + + ```sh + # Latest version + git clone --depth 1 https://github.com/dchakro/alacritty_colors.git + # Full repo + git clone https://github.com/dchakro/alacritty_colors.git + + cd alacritty_colors + chmod +x show_colors.sh apply_theme.sh + ``` + +2. Enable `Live Config Reload` for alacritty if it is not enabled already by adding the followin line in your `~/.alacritty.yml`. + + ```properties + live_config_reload: true + ``` + +Here is a shell command to do it. + + ```sh + echo "live_config_reload: true" >> ~/.alacritty.yml + +3. Overwrite the [base.yml](./base.yml) with your `~/.alacritty.yml`. + + ```sh + cd /path/to/alacritty_colors + cp ~/.alacritty.yml ./base.yml + ``` + +4. (***Optional***) Remove the current color scheme (if any) from the file `base.yml`, so that the "**reset**" function in the included script will restore default alacritty colors. Otherwise it will restore your current color scheme. + +5. Apply/Backup/Reset themes using + + ```sh + ./apply_theme.sh + ``` + +## Demo + +Here is a quick demo of the process of applying themes to alacritty. + +![demo.gif](assets/demo.gif) + + + +## Info + +If you want to view the colors from your current color scheme without cloning this repo, you can do so by running: ```sh curl -sL 'https://raw.githubusercontent.com/dchakro/alacritty_colors/master/show_colors.sh' | bash ``` +## Note: ++ Most of these themes are (as-is or modified) from [alacritty's wiki](https://github.com/alacritty/alacritty/wiki/Color-schemes). ++ + While making this repo I didn’t realize that there are repos like [eendroroy’s](https://github.com/eendroroy/alacritty-theme) and [rajasegar's](https://github.com/rajasegar/alacritty-themes) repos where they have been putting in the effort for a long time. I will maintain this repo to archive other color schemes that I might find interesting over time. + + Unlike their repos this repo provides open-source simple bash scripts to view the theme colors and apply the themes. -**NB:** While making this repo I didn’t realize that there are repos like [eendroroy’s](https://github.com/eendroroy/alacritty-theme) where they have been putting in the effort for a long time to curate content. I will maintain this repo to archive other color schemes that I might find interesting over time and develop a way to apply color schemes from the CLI. +## Preview of themes - -## [Argonaut](https://github.com/pwaleczek/Argonaut-theme) [YML](themes/argonaut.yml) +### [Argonaut](https://github.com/pwaleczek/Argonaut-theme) [YML](themes/argonaut.yml) ![image-20200730153019490](assets/argonaut.png) -## Ayu Mirage [YML](themes/ayuMirage.yml) +### Ayu Mirage [YML](themes/ayuMirage.yml) ![image-20200730153019490](assets/ayuMirage.png) -## [Blood Moon](https://github.com/dguo/blood-moon) [YML](themes/bloodmoon.yml) +### [Blood Moon](https://github.com/dguo/blood-moon) [YML](themes/bloodmoon.yml) Bright yellow changed to `#FFD700` ![image-20200730153216611](assets/bloodmoon.png) -## Breeze (KDE) [YML](themes/breeze.yml) +### Breeze (KDE) [YML](themes/breeze.yml) ![image-20200730153019490](assets/breeze.png) -## Breeze2 [YML](themes/breeze2.yml) +### Breeze2 [YML](themes/breeze2.yml) modified from KDE Breeze by robocopAlpha ![breeze2](./assets/breeze2.png) -## Darktooth [YML](themes/darktooth.yml) +### Darktooth [YML](themes/darktooth.yml) ![image-20200730153019490](assets/darktooth.png) -## Dracula [YML](themes/dracula.yml) +### Dracula [YML](themes/dracula.yml) ![image-20200730153019490](assets/dracula.png) -## Gruvbox [YML](themes/gruvbox.yml) +### Gruvbox [YML](themes/gruvbox.yml) ![image-20200730153019490](assets/gruvbox.png) -## [Hyper](https://hyper.is/) [YML](themes/hyper.yml) +### [Hyper](https://hyper.is/) [YML](themes/hyper.yml) The color Yellow `#FFD700` has taken from [Blood Moon](themes/bloodmoon.yml). ![image-20200730153904592](assets/hyper.png) -## Iterm Default [YML](themes/iterm2.yml) +### Iterm Default [YML](themes/iterm2.yml) ![image-20200730154037517](assets/iterm2.png) -## Kitty [YML](themes/kitty.yml) +### Kitty [YML](themes/kitty.yml) ![image-20200730153019490](assets/kitty.png) -## [Material Theme](https://github.com/equinusocio/material-theme) [YML](themes/material.yml) +### [Material Theme](https://github.com/equinusocio/material-theme) [YML](themes/material.yml) ![image-20200730154203299](assets/material.png) -## Metro Style [YML](./themes/metrostyle.yml) +### Metro Style [YML](./themes/metrostyle.yml) ![metrostyle](assets/metrostyle.png) -## Monokai Soda [YML](themes/monokaiSoda.yml) +### Monokai Soda [YML](themes/monokaiSoda.yml) ![image-20200730154326639](assets/monokaiSoda.png) -## Pop OS [YML](themes/pop_OS.yml) +### Pop OS [YML](themes/pop_OS.yml) ![image-20200730155432908](assets/pop_OS.png) -## robocopAlpha Colors [YML](themes/robocopAlpha.yml) +### robocopAlpha Colors [YML](themes/robocopAlpha.yml) ![image-20200730160014996](assets/robocopAlpha.png) -## [Seabird](https://github.com/nightsense/seabird) [YML](themes/seabird.yml) +### [Seabird](https://github.com/nightsense/seabird) [YML](themes/seabird.yml) Foreground color has been made darker `#1A1A1A` than original to improve contrast ![image-20200730154721260](assets/seabird.png) -## Spacemacs light [YML](themes/spacemacsLight.yml) +### Spacemacs light [YML](themes/spacemacsLight.yml) Changes: green to `#009F6B` and magenta to `#29A0AD`. ![image-20200730160138239](assets/spacemacsLight.png) -## Spacer by robocopAlpha [YML](./themes/spacer.yml) +### Spacer by robocopAlpha [YML](./themes/spacer.yml) Tried to map colors from the Spacemacs Light theme to ones “similar” to the names of the colors. ![spacer](assets/spacer.png) -## Terminal app basic [YML](themes/terminalBasic.yml) +### Terminal app basic [YML](themes/terminalBasic.yml) ![image-20200730155241817](assets/terminalBasic.png) -## Ubuntu [YML](themes/ubuntu.yml) +### Ubuntu [YML](themes/ubuntu.yml) ![image-20200730155325668](assets/ubuntu.png)