merged with develop branch.

Author: mubin-thinks

README.md

@@ -1,6 +1,6 @@
 <div align="center">
     <h1>charcoal</h1>
-    <p>A warm and calm color scheme.</p>
+    <p>A warm and simple colorscheme.</p>
 
 **[Preview] | [Install] | [Contribute]**
 </div>
@@ -9,21 +9,39 @@
 [Install]: https://github.com/mubin6th/charcoal?tab=readme-ov-file#install
 [Contribute]: https://github.com/mubin6th/charcoal?tab=readme-ov-file#contribute
 
+## About
+Charcoal is a warm colorscheme for text-editors, terminals, UI and more. The colorscheme
+resembles warm/rural weather, wheat field, afternoon sky etc. The dark background of
+Charcoal Dark is meant to help distinguish Code from UI. Charcoal is inspired by Gruvbox
+and Gruvbox Material colorschemes and tries to be simple and easy-on-eyes theme.
+
+### Features
+- Warm and easy-on-eyes colors.
+- Total of 10 monochromatic colors for each monochrome mode.
+- Simple dark and light shades.
+- Support for real-time color editing through [color_grid](https://github.com/mubin6th/charcoal/blob/develop/color_grid).
+
 ## Preview
-> [!WARNING]
-> The preview will not arrive until the initial release(v0.0.1). And the previous showcase
-> is now no longer shown.
+<a href="https://github.com/mubin6th/charcoal/blob/develop/readme_resources/preview_neovim_v1.0.0.png?raw=true"><img alt="preview_neovim_v1.0.0.png" src="https://github.com/mubin6th/charcoal/blob/develop/readme_resources/preview_neovim_v1.0.0.png?raw=true"></a>
 
 ## Palette
-> [!WARNING]
-> The palette preview will not arrive until initial release(v0.0.1). After which, the
-> color palette will preview the latest stable version.
-
-## Install
-Currently the theme is only available for Neovim. The
-[echasnovski/mini.nvim](https://github.com/echasnovski/mini.nvim) plugin set is used for
-this colorscheme. You have to make sure you have **lazy.nvim** installed. You can
-currently only install [charcoal dark](https://github.com/mubin6th/charcoal/blob/master/nvim/charcoal_dark.lua) from the hyperlink.
+Here is the text form of the palette, I faced difficulties creating a grid layout.
+Therefore, the text form is below:
+```
+-- Dark mode (Monochrome)     |         -- Light mode (Monochrome)
+warm_black1 = #0f0b05         |         warm_white1 = #928363
+warm_black2 = #1b140a         |         warm_white2 = #9f8f6d
+warm_black3 = #231b0e         |         warm_white3 = #af9f7d
+warm_black4 = #2a2012         |         warm_white4 = #bcad8c
+warm_black5 = #342818         |         warm_white5 = #cabda0
+                              |
+warm_white1 = #57462c         |         warm_black1 = #0b0904
+warm_white2 = #876e48         |         warm_black2 = #251e0f
+warm_white3 = #a88c62         |         warm_black3 = #382e1b
+warm_white4 = #c3a983         |         warm_black4 = #4b3e26
+warm_white5 = #dec8a7         |         warm_black5 = #645538
+```
 
 ## Contribute
-If you want to **suggest** any change to the palette, let me know. I will kindly take your opinion, Insha'allah.
+If you would like to suggest any change to the palette, let me know. I will kindly view
+your opinion, Insha'allah.

alacritty/README.md

@@ -0,0 +1,6 @@
+## Installing Charcoal for Alacritty
+In order to install Charcoal for the Alacritty terminal, you will have to edit some
+files. You can use your favourite text-editor. Copy the contents of your preferred
+colorscheme from Charcoal Repository's `alacritty/` folder. After you have copied all the
+contents of your preferred theme file, paste it at the top of your
+`~/.config/alacritty/alacritty.toml`.

alacritty/charcoal_monochrome_dark.toml

@@ -0,0 +1,23 @@
+[colors.primary]
+background = '#0f0b05'
+foreground = '#a88c62'
+
+[colors.normal]
+black   = '#0f0b05'
+white   = '#c3a983'
+red     = '#c3a983'
+green   = '#a88c62'
+blue    = '#a88c62'
+yellow  = '#c3a983'
+cyan    = '#876e48'
+magenta = '#876e48'
+
+[colors.bright]
+black   = '#231b0e'
+white   = '#dec8a7'
+red     = '#dec8a7'
+green   = '#c3a983'
+blue    = '#c3a983'
+yellow  = '#dec8a7'
+cyan    = '#a88c62'
+magenta = '#a88c62'

alacritty/charcoal_monochrome_light.toml

@@ -0,0 +1,23 @@
+[colors.primary]
+background = '#cabda0'
+foreground = '#382e1b'
+
+[colors.normal]
+black   = '#0b0904'
+white   = '#bcad8c'
+red     = '#251e0f'
+green   = '#382e1b'
+blue    = '#4b3e26'
+yellow  = '#382e1b'
+cyan    = '#4b3e26'
+magenta = '#4b3e26'
+
+[colors.bright]
+black   = '#928363'
+white   = '#cabda0'
+red     = '#0b0904'
+green   = '#251e0f'
+blue    = '#382e1b'
+yellow  = '#251e0f'
+cyan    = '#382e1b'
+magenta = '#382e1b'

base16_descriptions.txt

@@ -1,21 +1,21 @@
-base00 = "#120f09", -- background
-base01 = "#1e1812", -- brigher background (for status bars, line number,
---                     folding marks)
-base02 = "#35291d", -- selection background
-base03 = "#66553f", -- comments, invisibles, line highlighting
-base04 = "#a28662", -- dark foreground (for status bars)
-base05 = "#c0a179", -- foreground
-base06 = "#d6b891", -- bright foreground
-base07 = "#292016", -- bright background
-base08 = "#887254", -- variables, xml tags, markup link text, markup lists,
---                     diff deleted
-base09 = "#d6b891", -- integer, boolean, constants, xml attributes, markup link
---                     url
-base0A = "#c0a179", -- classes, markup bold, search text background
-base0B = "#a28662", -- strings, inherited class, markup code, diff inserted
-base0C = "#a28662", -- data types, support, regular expressions,
---                     escape characters, markup, quotes
-base0D = "#d6b891", -- functions, methods, attribute ids, headings
-base0E = "#a28662", -- keywords, storage, selector, markup italic, diff changed
-base0F = "#887254", -- deprecated, opening/closing embedded language tags,
---                     e.g. `<?php ?>`
+base00 -- background
+base01 -- brigher background (for status bars, line number,
+       -- folding marks)
+base02 -- selection background
+base03 -- comments, invisibles, line highlighting
+base04 -- dark foreground (for status bars)
+base05 -- foreground
+base06 -- bright foreground
+base07 -- bright background
+base08 -- variables, xml tags, markup link text, markup lists,
+       -- diff deleted
+base09 -- integer, boolean, constants, xml attributes, markup link
+       -- url
+base0A -- classes, markup bold, search text background
+base0B -- strings, inherited class, markup code, diff inserted
+base0C -- data types, support, regular expressions,
+       -- escape characters, markup, quotes
+base0D -- functions, methods, attribute ids, headings
+base0E -- keywords, storage, selector, markup italic, diff changed
+base0F -- deprecated, opening/closing embedded language tags,
+       -- e.g. `<?php ?>`

charcoal_dark_colors.txt

@@ -0,0 +1,11 @@
+warm_black1 = #0f0b05
+warm_black2 = #1b140a
+warm_black3 = #231b0e
+warm_black4 = #2a2012
+warm_black5 = #342818
+
+warm_white1 = #57462c
+warm_white2 = #876e48
+warm_white3 = #a88c62
+warm_white4 = #c3a983
+warm_white5 = #dec8a7

charcoal_monochrome_dark_colors.txt

@@ -0,0 +1,11 @@
+warm_white1 = #928363
+warm_white2 = #9f8f6d
+warm_white3 = #af9f7d
+warm_white4 = #bcad8c
+warm_white5 = #cabda0
+
+warm_black1 = #0b0904
+warm_black2 = #251e0f
+warm_black3 = #382e1b
+warm_black4 = #4b3e26
+warm_black5 = #645538

charcoal_monochrome_light_colors.txt

@@ -2,20 +2,23 @@
 
 A tool to generate image from a colorscheme file.
 
-A colorscheme file can be any file where hex colors are separated by spaces. The colors
-can be in every newline or in between paragraphs.
+A colorscheme file can be any file where hex colors are
+separated by spaces. The colors can be in every newline
+or in between paragraphs.
 
 The help command of the tool below:
 ```
 Usage: colorgrid [arguments...]
-A program to take hex separated colors from file and make a color grid.
+A program to take hex separated colors from file and make
+a color grid.
 
     -i, --input=<str>     path to text file.
     -r, --rows=<int>      the number of rows. default: 1.
-    -c, --columns=<int>   the number of columns. default: 0.
+    -c, --columns=<int>   the number of columns. default: 0. (meaning, the column is arbitary by default)
     -x, --width=<int>     tile width. default: 64.
     -y, --height=<int>    tile height. default: 64.
-    -w, --watch           preview changes to color palette. helpful when editing.
+    -w, --watch           preview changes to color palette.
+                          helpful when editing.
     -v, --version         print version of colorgrid.
     -h, --help            show this help message and exit
 ```

color_grid/README.md

@@ -18,11 +18,10 @@ static const char *const arg_usages[] = {
 };
 static struct argparse_option arg_options[] = {
     OPT_STRING('i', "input", &arg_g.path, "path to text file.", NULL, 0, 0),
-    OPT_INTEGER('r', "rows", &arg_g.row, "the number of rows. default: 1. "
-                "row is arbitary on watch mode.", NULL, 0,
+    OPT_INTEGER('r', "rows", &arg_g.row, "the number of rows. default: 1. ", NULL, 0,
                 0),
-    OPT_INTEGER('c', "columns", &arg_g.col, "the number of columns. default: 0.",
-                NULL, 0, 0),
+    OPT_INTEGER('c', "columns", &arg_g.col, "the number of columns. default: 0. "
+                "(meaning, the column is arbitary by default)", NULL, 0, 0),
     OPT_INTEGER('x', "width", &arg_g.width, "tile width. default: 64.", NULL, 0, 0),
     OPT_INTEGER('y', "height", &arg_g.height, "tile height. default: 64.", NULL, 0,
                 0),