mirror of
https://github.com/ivuorinen/everforest-resources.git
synced 2026-01-26 11:13:59 +00:00
Ismo Vuorinen
11baabe545
- Complete project structure with directories for all target platforms - Template system for CLI tools with color placeholder replacement - Working generator that processes templates for 6 theme variants - GitHub workflows for build, snapshots, commitlint, and cli-verify - Installer and verifier scripts for CLI tool deployment - Comprehensive documentation and specifications - Biome 2.x linting and formatting setup - Husky git hooks for pre-commit validation
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# Everforest Resources
|
||
|
||
Unofficial hub for Everforest color scheme resources. Generator-first approach for terminals, CLI tools, editors, and web.
|
||
|
||
## Quick Start
|
||
|
||
# Generate all themes
|
||
npm run generate
|
||
|
||
# Install CLI configurations
|
||
./cli/install.sh
|
||
|
||
# Verify installation
|
||
ENGINE=docker ./verify/verify.sh
|
||
|
||
## Supported Tools
|
||
|
||
### Terminals
|
||
WezTerm, Alacritty, Kitty, Windows Terminal, Ghostty
|
||
|
||
### CLI Tools
|
||
Starship, FZF, Delta, Tmux, Fish, LS_COLORS, and 20+ more
|
||
|
||
### Editors
|
||
Neovim, VS Code, JetBrains IDEs, Zed, Sublime Text
|
||
|
||
## Theme Variants
|
||
|
||
6 variants total: dark/light × hard/medium/soft
|
||
|
||
## Development
|
||
|
||
npm run lint # Lint code
|
||
npm run generate # Generate themes
|
||
npm run validate # Validate outputs
|
||
npm run ci # Full CI pipeline
|
||
|
||
## Contributing
|
||
|
||
1. Edit only `palettes/everforest.json` and `template.txt` files
|
||
2. Run `npm run generate`
|
||
3. Commit palette + template + generated files
|
||
4. Follow conventional commits
|
||
|
||
**Important**: Never edit generated files directly. All outputs are generated from templates.
|
||
|
||
## CI Requirements
|
||
|
||
All checks must pass: lint + build + snapshots + commitlint + cli-verify
|