Skip to content

Commit

Permalink
docs: expanded README with explanation and new assets
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick.dewey committed Jun 25, 2024
1 parent 4b99ec8 commit 579dd9d
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# darkearth-nvim

A dark and earthy colorscheme for Neovim.

<p align="center">
<img src="assets/color_bar.png" alt="DarkEarth palette"/>
</p>

Based on [miasma.nvim](https://github.com/xero/miasma.nvim), and built with [lush](https://github.com/rktjmp/lush.nvim).
Compare to Miasma, darkearth is built to be more colorful overall to reduce sameyness as well as being more centered around browns than grays to enhance the earthiness.

<p align="center">
<img src="assets/screenshot-0.png" alt="DarkEarth theme in neovim"/>
</p>

![](assets/screenshot-0.png)

## Installation

Expand All @@ -23,20 +32,20 @@ use {
```

## Usage

```lua
-- enable the colorscheme
vim.cmd.colorscheme("darkearth")
```

## Build/Modify Colorscheme
## Build and Modify Colorscheme

1. Ensure [lush.nvim](https://github.com/rktjmp/lush.nvim) and [shipwright.nvim](https://github.com/rktjmp/shipwright.nvim) are installed
2. Add new modifications to [lush_theme/darkearth.lua](lush_theme/darkearth.lua)
3. Rebuild the colorscheme by running `./build.sh`
3. Rebuild the colorscheme using `./build/build.sh`


## base16 Colorscheme
I have also included a base16 colorscheme script [base16-darkearth.sh](base16-darkearth.sh) that can be used to set shell colors.
## Base16 Colorscheme

I have also included a base16 colorscheme script [extras/base16-darkearth.sh](extras/base16-darkearth.sh) that can be used to set shell colors.

## Disclaimer
This color scheme is fairly early in development and things are subject to change. (Changes will primarily be new additions)
Binary file added assets/color_bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 579dd9d

Please sign in to comment.