# everforest

**Repository Path**: Jack2021/everforest

## Basic Information

- **Project Name**: everforest
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-03-20
- **Last Updated**: 2024-04-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">
𝐄𝐯𝐞𝐫𝐟𝐨𝐫𝐞𝐬𝐭
</h1>

|        |                                      𝐃𝐚𝐫𝐤                                      |                                      𝐋𝐢𝐠𝐡𝐭                                       |
| :----: | :----------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
|  𝐇𝐚𝐫𝐝  |   ![hard-dark](https://gitlab.com/sainnhe/img/-/raw/master/fn-dark-hard.png)   |   ![hard-light](https://gitlab.com/sainnhe/img/-/raw/master/fn-light-hard.png)   |
| 𝐌𝐞𝐝𝐢𝐮𝐦 | ![medium-dark](https://gitlab.com/sainnhe/img/-/raw/master/fn-dark-medium.png) | ![medium-light](https://gitlab.com/sainnhe/img/-/raw/master/fn-light-medium.png) |
|  𝐒𝐨𝐟𝐭  |   ![soft-dark](https://gitlab.com/sainnhe/img/-/raw/master/fn-dark-soft.png)   |   ![soft-light](https://gitlab.com/sainnhe/img/-/raw/master/fn-light-soft.png)   |

## Introduction

Everforest is a green based color scheme, it's designed to be warm and soft in order to protect developers' eyes.

### Features

- Green based but warm-toned.
- Designed to have soft contrast for eye protection.
- Works well with [redshift](https://github.com/jonls/redshift) and [f.lux](https://justgetflux.com).
- Customizable.
- Rich support for common file types and plugins.
- [Italic support](https://github.com/sainnhe/icursive-nerd-font) 🎉

## Installation

### Via Plugin Manager

Take [vim-plug](https://github.com/junegunn/vim-plug) for example:

```vim
Plug 'sainnhe/everforest'
```

For better syntax highlighting support, please install [sheerun/vim-polyglot](https://github.com/sheerun/vim-polyglot) or [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).

### Manually

1. Clone this repository.
2. Copy `/path/to/everforest/autoload/everforest.vim` to `~/.vim/autoload/`.
3. Copy `/path/to/everforest/colors/everforest.vim` to `~/.vim/colors/everforest.vim`
4. Copy `/path/to/everforest/doc/everforest.txt` to `~/.vim/doc/` and execute `:helptags ~/.vim/doc` to generate help tags.
5. To install [airline](https://github.com/vim-airline/vim-airline) theme, copy `/path/to/everforest/autoload/airline/themes/everforest.vim` to `~/.vim/autoload/airline/themes/`
6. To install [lightline](https://github.com/itchyny/lightline.vim) theme, copy `/path/to/everforest/autoload/lightline/colorscheme/everforest.vim` to `~/.vim/autoload/lightline/colorscheme/`

### AUR

There are some packages available for Arch Linux users in AUR:

- [vim-everforest-git](https://aur.archlinux.org/pkgbase/vim-everforest-git/)
- [neovim-everforest-git](https://aur.archlinux.org/pkgbase/neovim-everforest-git/)

## Usage

See [`:help everforest.txt`](https://github.com/sainnhe/everforest/blob/master/doc/everforest.txt)

## Related Projects

See this [wiki page](https://github.com/sainnhe/everforest/wiki).

## More Color Schemes

- [Gruvbox Material](https://github.com/sainnhe/gruvbox-material)
- [Edge](https://github.com/sainnhe/edge)
- [Sonokai](https://github.com/sainnhe/sonokai)

## Inspirations

- [rhysd/vim-color-spring-night](https://github.com/rhysd/vim-color-spring-night)
- [KKPMW/sacredforest-vim](https://github.com/KKPMW/sacredforest-vim)
- [morhetz/gruvbox](https://github.com/morhetz/gruvbox)
- [altercation/vim-colors-solarized](https://github.com/altercation/vim-colors-solarized)

## Maintainers

| [![Sainnhe Park](https://avatars1.githubusercontent.com/u/37491630?s=70&u=14e72916dcf467f393c532536387ec72a23747ec&v=4)](https://github.com/sainnhe) | [![Jef LeCompte](https://avatars0.githubusercontent.com/u/12074633?s=70&u=425e7f9db7a80a6615fd0d89bd58afdf7bddfda1&v=4)](https://github.com/jef) |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Sainnhe Park](https://github.com/sainnhe)                                                                                                           | [Jef LeCompte](https://github.com/jef)                                                                                                           |

## License

[MIT](./LICENSE)