From 36923498bfa4541ebcdfedb065e48e305c8d3cc7 Mon Sep 17 00:00:00 2001 From: Mgldvd Date: Sun, 26 Feb 2023 20:17:42 -0500 Subject: [PATCH] Update readme with: Create your own theme --- README.md | 10 ++-- content/howto.md | 119 ------------------------------------- {content => pages}/help.md | 2 +- pages/howto.md | 82 +++++++++++++++++++++++++ test/README.md | 2 +- 5 files changed, 89 insertions(+), 126 deletions(-) delete mode 100644 content/howto.md rename {content => pages}/help.md (93%) create mode 100644 pages/howto.md diff --git a/README.md b/README.md index 74c4c05..8da0463 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Color Schemes For Ubuntu, Linux Mint, Elementary OS and all distributions that u - [Install (non-interactive mode)](https://github.com/Gogh-Co/Gogh#%EF%B8%8F-install-non-interactive-mode) - [Terminals](https://github.com/Gogh-Co/Gogh#-terminals) - [Themes](https://github.com/Gogh-Co/Gogh#-themes) -- [How to?](https://github.com/Gogh-Co/Gogh#-how-to) +- [Create your own theme](https://github.com/Gogh-Co/Gogh#-how-to) - [First commit](https://github.com/Gogh-Co/Gogh#-first-commit) - [Credits](https://github.com/Gogh-Co/Gogh#heart-credits) - [Contributors](https://github.com/Gogh-Co/Gogh#heart-contributors) @@ -88,9 +88,9 @@ bash -c "$(curl -sLo- https://git.io/vQgMr)"
-## :thinking: [Help](https://github.com/Gogh-Co/Gogh/blob/master/content/help.md) +## :thinking: [Help](https://github.com/Gogh-Co/Gogh/blob/master/pages/help.md) - - [link to page](https://github.com/Gogh-Co/Gogh/blob/master/content/help.md) + - [link to page](https://github.com/Gogh-Co/Gogh/blob/master/pages/help.md)
@@ -146,9 +146,9 @@ also all themes in json format: https://raw.githubusercontent.com/Gogh-Co/Gogh/m
-## 📌 [How to](https://github.com/Gogh-Co/Gogh/blob/master/content/howto.md) +## 📌 [Create your own theme](https://github.com/Gogh-Co/Gogh/blob/master/pages/howto.md) -If you want to create your own color scheme or contribute to the project, [start here](https://github.com/Gogh-Co/Gogh/blob/master/content/howto.md). +If you want to create your own color scheme or contribute to the project, [start here](https://github.com/Gogh-Co/Gogh/blob/master/pages/howto.md).
diff --git a/content/howto.md b/content/howto.md deleted file mode 100644 index 1392212..0000000 --- a/content/howto.md +++ /dev/null @@ -1,119 +0,0 @@ - -![elementary](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/Gogh-logo.png) - ------ - -## How To - -#### New Script - -To have more control over colors, I made a new simple script to change those made with 4 bits. -This new script has variables which can be set according to preferences. -Please feel free to use and create your own color schemes. - -**You can send Pull Request.** - -- **The Script** - -https://github.com/Gogh-Co/Gogh/blob/master/_base.sh - -- **Variables** - -```bash - # Section 1 - COLOR_01="#363636" # HOST - COLOR_02="#ff0883" # SYNTAX_STRING - COLOR_03="#83ff08" # COMMAND - COLOR_04="#ff8308" # COMMAND_COLOR2 - COLOR_05="#0883ff" # PATH - COLOR_06="#8308ff" # SYNTAX_VAR - COLOR_07="#08ff83" # PROMP - COLOR_08="#b6b6b6" # - - # Section 2 - COLOR_09="#424242" # - COLOR_10="#ff1e8e" # COMMAND_ERROR - COLOR_11="#8eff1e" # EXEC - COLOR_12="#ff8e1e" # - COLOR_13="#1e8eff" # FOLDER - COLOR_14="#8e1eff" # - COLOR_15="#1eff8e" # - COLOR_16="#c2c2c2" # - - # Section 3 - BACKGROUND_COLOR="#0d1926" # Background Color - FOREGROUND_COLOR="#b4e1fd" # Text - CURSOR_COLOR="$FOREGROUND_COLOR" # Cursors -``` -- **Explanation of colors and variables** - -The colors of the terminal are composed of 18 colors in 3 sections. - -Section 1: Regular text. - -Section 2: Bold text. - -Section 3: text and background. - -The basic colors are 8: - -- Black -- Red -- Green -- Yellow -- Blue -- Purple -- Cyan -- White - -In comments variables is that of the console belongs each color. - -Here is a picture that explains a little better as colors are distributed. - -![Colors](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/colors.png) - -- **View Colors** - -You can use this alias to view your color scheme in terminal - -```bash -color () { - # echo "" - #black - echo -e "\e[0;30m ███ *** AaBbCs --- ███ \\e[0m ---> Color 01 0;30m" - #red - echo -e "\e[0;31m ███ *** AaBbCs --- ███ \\e[0m ---> Color 02 0;31m" - #green - echo -e "\e[0;32m ███ *** AaBbCs --- ███ \\e[0m ---> Color 03 0;32m" - #yellow - echo -e "\e[0;33m ███ *** AaBbCs --- ███ \\e[0m ---> Color 04 0;33m" - #blue - echo -e "\e[0;34m ███ *** AaBbCs --- ███ \\e[0m ---> Color 05 0;34m" - #purple - echo -e "\e[0;35m ███ *** AaBbCs --- ███ \\e[0m ---> Color 06 0;35m" - #cyan - echo -e "\e[0;36m ███ *** AaBbCs --- ███ \\e[0m ---> Color 07 0;36m" - #white - echo -e "\e[0;37m ███ *** AaBbCs --- ███ \\e[0m ---> Color 08 0;37m" - echo "" - #black - echo -e "\e[1;30m ███ *** AaBbCs --- ███ \\e[0m ---> Color 09 1;30m" - #red - echo -e "\e[1;31m ███ *** AaBbCs --- ███ \\e[0m ---> Color 10 1;31m" - #green - echo -e "\e[1;32m ███ *** AaBbCs --- ███ \\e[0m ---> Color 11 1;32m" - #yellow - echo -e "\e[1;33m ███ *** AaBbCs --- ███ \\e[0m ---> Color 12 1;33m" - #blue - echo -e "\e[1;34m ███ *** AaBbCs --- ███ \\e[0m ---> Color 13 1;34m" - #purple - echo -e "\e[1;35m ███ *** AaBbCs --- ███ \\e[0m ---> Color 14 1;35m" - #cyan - echo -e "\e[1;36m ███ *** AaBbCs --- ███ \\e[0m ---> Color 15 1;36m" - #white - echo -e "\e[1;37m ███ *** AaBbCs --- ███ \\e[0m ---> Color 16 1;37m" - echo "" - echo -e "\e[0;30m█████\\e[0m\e[0;31m█████\\e[0m\e[0;32m█████\\e[0m\e[0;33m█████\\e[0m\e[0;34m█████\\e[0m\e[0;35m█████\\e[0m\e[0;36m█████\\e[0m\e[0;37m█████\\e[0m" - echo -e "\e[0m\e[1;30m█████\\e[0m\e[1;31m█████\\e[0m\e[1;32m█████\\e[0m\e[1;33m█████\\e[0m\e[1;34m█████\\e[0m\e[1;35m█████\\e[0m\e[1;36m█████\\e[0m\e[1;37m█████\\e[0m" -} -``` diff --git a/content/help.md b/pages/help.md similarity index 93% rename from content/help.md rename to pages/help.md index da2dcbc..2313de2 100644 --- a/content/help.md +++ b/pages/help.md @@ -1,5 +1,5 @@ -![elementary](https://raw.githubusercontent.com/Gogh-Co/Elementary-OS-Terminal-Colors/master/images/gogh/Gogh-logo.png) +![Gogh](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/Gogh-logo.png) ----- diff --git a/pages/howto.md b/pages/howto.md new file mode 100644 index 0000000..fd6bff6 --- /dev/null +++ b/pages/howto.md @@ -0,0 +1,82 @@ + +![Gogh](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/Gogh-logo.png) + +----- + +## How to ceate your own theme + +Good news! Contributing with new themes is now easier and less intimidating. + +You just need to create a YAML format file, following the example of the other files in the `themes` folder. + +Please keep in mind a few simple rules. + +- The file name should match the name of the theme. For example: + - **Filename**: `Adventure Time.yml` + - **Inside the .yml file**: `name: 'Adventure Time'` +- Use title case for all words by capitalizing their first letter. +- Ensure that the contrast is sufficient for good legibility. + +**Now you can send Pull Request.** + +**Thank you!** + +--- + +## Theme .yml example + +```yml +--- +name: 'Adventure Time' + +color_01: '#050404' # Black (Host) +color_02: '#BD0013' # Red (Syntax string) +color_03: '#4AB118' # Green (Command) +color_04: '#E7741E' # Yellow (Command second) +color_05: '#0F4AC6' # Blue (Path) +color_06: '#665993' # Magenta (Syntax var) +color_07: '#70A598' # Cyan (Prompt) +color_08: '#F8DCC0' # White + +color_09: '#4E7CBF' # Bright Black +color_10: '#FC5F5A' # Bright Red (Command error) +color_11: '#9EFF6E' # Bright Green (Exec) +color_12: '#EFC11A' # Bright Yellow +color_13: '#1997C6' # Bright Blue (Folder) +color_14: '#9B5953' # Bright Magenta +color_15: '#C8FAF4' # Bright Cyan +color_16: '#F6F5FB' # Bright White + +background: '#1F1D45' # Background +foreground: '#F8DCC0' # Foreground (Text) + +cursor: '#F8DCC0' # Cursor +``` +--- +## Explanation of colors and variables + +The colors of the terminal are composed of 18 colors in 3 sections. + +Section 1: Regular text. + +Section 2: Bold text. + +Section 3: text and background. + +The basic colors are 8: + +- Black +- Red +- Green +- Yellow +- Blue +- Purple +- Cyan +- White + +In comments variables is that of the console belongs each color. + +Here is a picture that explains a little better as colors are distributed. + +![Colors](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/colors.png) + diff --git a/test/README.md b/test/README.md index 23a7e29..3c3be9b 100644 --- a/test/README.md +++ b/test/README.md @@ -1,5 +1,5 @@ -![elementary](https://raw.githubusercontent.com/Gogh-Co/Elementary-OS-Terminal-Colors/master/images/gogh/Gogh-logo.png) +![Gogh](https://raw.githubusercontent.com/Gogh-Co/Gogh/master/images/gogh/Gogh-logo.png) -----