chore: update theme (fjord-core@2b6fe52)
This commit is contained in:
136
README.md
Normal file
136
README.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# Fjord Theme for Tmux
|
||||
|
||||
A clean and elegant tmux color theme plugin with the Fjord color scheme inspired by Nord and Ayu Mirage.
|
||||
|
||||
## 🎨 Color Palette
|
||||
|
||||
### Core Colors
|
||||
|
||||
| Color | Name |
|
||||
| ---- | ----------------- |
|
||||
|  | **background** |
|
||||
|  | **backgroundAlt** |
|
||||
|  | **surface** |
|
||||
|  | **line** |
|
||||
|  | **foreground** |
|
||||
|  | **muted** |
|
||||
|  | **mutedDim** |
|
||||
|
||||
### Accent Colors
|
||||
|
||||
| Color | Name |
|
||||
| ---- | ---------------------------- |
|
||||
|  | **green** _(primary accent)_ |
|
||||
|  | **blue** |
|
||||
|  | **yellow** |
|
||||
|  | **purple** |
|
||||
|  | **red** |
|
||||
|  | **cyan** |
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
|
||||
### Manual Installation
|
||||
|
||||
|
||||
1. Clone this repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/fjord-themes/fjord-tmux.git --depth 1
|
||||
```
|
||||
|
||||
|
||||
|
||||
2. Add the theme to your Tmux config (`~/.tmux.conf`):
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Using TPM
|
||||
|
||||
Add this line to your `~/.tmux.conf`:
|
||||
|
||||
```tmux
|
||||
set -g @plugin 'fjord-theme/fjord-tmux'
|
||||
```
|
||||
|
||||
Then press `prefix` + <kbd>I</kbd> to fetch and install the plugin.
|
||||
|
||||
### Manual Installation
|
||||
|
||||
|
||||
1. Clone this repository:
|
||||
```bash
|
||||
git clone https://github.com/fjord-theme/fjord-tmux ~/.tmux/plugins/fjord-tmux
|
||||
```
|
||||
|
||||
2. Add this line to your `~/.tmux.conf`:
|
||||
```tmux
|
||||
run '~/.tmux/plugins/fjord-tmux/fjord.tmux'
|
||||
```
|
||||
|
||||
3. Reload tmux configuration:
|
||||
```bash
|
||||
tmux source-file ~/.tmux.conf
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Status Content
|
||||
|
||||
To disable the status bar content:
|
||||
|
||||
```tmux
|
||||
set -g @fjord_tmux_show_status_content 0
|
||||
```
|
||||
|
||||
### Date Format
|
||||
|
||||
Customize the date format in the status bar:
|
||||
|
||||
```tmux
|
||||
set -g @fjord_tmux_date_format "%Y-%m-%d"
|
||||
```
|
||||
|
||||
### No Patched Font
|
||||
|
||||
If you don't have a powerline-patched font installed, disable the special characters:
|
||||
|
||||
```tmux
|
||||
set -g @fjord_tmux_no_patched_font 1
|
||||
```
|
||||
|
||||
## Plugin Support
|
||||
|
||||
Fjord supports the following plugins:
|
||||
|
||||
- [tmux-prefix-highlight](https://github.com/tmux-plugins/tmux-prefix-highlight) - Shows a visual indicator when prefix is pressed
|
||||
|
||||
To use tmux-prefix-highlight, install it AFTER the Fjord theme:
|
||||
|
||||
```tmux
|
||||
set -g @plugin 'fjord-theme/tmux-fjord'
|
||||
set -g @plugin 'tmux-plugins/tmux-prefix-highlight'
|
||||
```
|
||||
## 📸 Preview
|
||||
|
||||

|
||||
|
||||
|
||||

|
||||
|
||||
## 🔄 Updates
|
||||
|
||||
This theme is automatically generated from [fjord-core](https://github.com/fjord-themes/fjord-core) and deployed on every release. For an overview of all supported platforms and the full color palette, visit the [Fjord theme page](https://github.com/fjord-themes/fjord).
|
||||
## ☕ Support My Work
|
||||
|
||||
If you enjoy the Fjord theme and find it useful, consider supporting my work:
|
||||
|
||||
[](https://buymeacoffee.com/jshuntley)
|
||||
## 📄 License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
## 🤝 Contributing
|
||||
|
||||
For theme suggestions or issues, please open an issue on [fjord-core](https://github.com/fjord-themes/fjord-core). For an overview of the project, visit the [Fjord theme page](https://github.com/fjord-themes/fjord).
|
||||
Reference in New Issue
Block a user