Skip to content

Commit 55407f4

Browse files
committed
README.md: completed all todos.
1 parent 9ec9c30 commit 55407f4

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<h1>charcoal.nvim</h1>
3-
<p>A simple monochrome colorscheme.</p>
3+
<p>A warm and simple colorscheme.</p>
44
<p><i>
55
This repository is derived from
66
<a href="https://github.com/mubin6th/charcoal">mubin6th/charcoal</a>.
@@ -20,7 +20,7 @@ Charcoal Dark is meant to help distinguish Code from UI. Charcoal is inspired by
2020
and Gruvbox Material colorschemes and tries to be simple and easy-on-eyes theme.
2121

2222
## Preview
23-
_todo_
23+
<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>
2424

2525
## Install
2626
Below are instructions to install Charcoal for different package managers:
@@ -32,7 +32,7 @@ Below are instructions to install Charcoal for different package managers:
3232
dependencies = { "nvim-mini/mini.base16" },
3333
priority = 1000,
3434
config = function()
35-
vim.cmd("colorscheme charcoal")
35+
vim.cmd("colorscheme charcoal_monochrome")
3636
end
3737
}
3838
```
@@ -44,9 +44,32 @@ MiniDeps.now(function()
4444
source = "mubin6th/charcoal.nvim",
4545
depends = { "nvim-mini/mini.base16" },
4646
})
47-
vim.cmd("colorscheme charcoal")
47+
vim.cmd("colorscheme charcoal_monochrome")
4848
end)
4949
```
5050

51+
### Switching between dark and light themes
52+
Switching between light and dark themes are done through `vim.o.background` variable.
53+
To switch to dark theme (the default), set the variable to `vim.o.background = 'dark'`
54+
and `vim.o.background = 'light'` otherwise.
55+
56+
Preferable to add it right before `vim.cmd("colorscheme charcoal_monochrome")`. Here is an
57+
example with lazy.nvim:
58+
```lua
59+
{
60+
"mubin6th/charcoal.nvim",
61+
dependencies = { "nvim-mini/mini.base16" },
62+
priority = 1000,
63+
config = function()
64+
vim.o.background = 'light' -- enables light mode
65+
vim.cmd("colorscheme charcoal_monochrome")
66+
end
67+
}
68+
```
69+
5170
## Contribute
52-
_todo_
71+
If you would like to contribute to the project through posting an issue, please do so.
72+
But as a reminder this repository does not accept any suggestions to change the
73+
colorscheme. If you would like to suggest any change please refer to
74+
[mubin6th/charcoal](https://github.com/mubin6th/charcoal). I will kindly view your
75+
opinion, Insha'allah.

colors/charcoal_monochrome.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
-- =============================================================================
2-
-- Name: Charcoal
2+
-- Name: Charcoal Monochrome
33
-- Description: A simple monochrome colorscheme.
44
-- Author: mubin6th
55
-- Website: https://github.com/mubin6th/charcoal.nvim

0 commit comments

Comments
 (0)