Skip to content

Commit

Permalink
docs: add missing extras instructions
Browse files Browse the repository at this point in the history
Fixes #44
  • Loading branch information
scottmckendry committed Feb 7, 2025
1 parent 78a08cd commit fb103ac
Show file tree
Hide file tree
Showing 7 changed files with 141 additions and 0 deletions.
7 changes: 7 additions & 0 deletions extras/lazygit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Usage

### Install

1. Save the contents of `cyberdream.yml` or `cyberdream-light.yml` to `~/.config/lazygit/config.yml`. If your `config.yml` doesn't exist, create the directory first with `mkdir -p ~/.config/lazygit`. If the config file already exists, you may want to back it up first.

See the [LazyGit documentation](https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md) for more information.
26 changes: 26 additions & 0 deletions extras/pywal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Usage

### Install

1. Save the contents of either theme file:

- Dark theme: Save `cyberdream.json` to `~/.config/wal/colorschemes/dark/cyberdream.json`
- Light theme: Save `cyberdream-light.json` to `~/.config/wal/colorschemes/light/cyberdream-light.json`

If the directories don't exist, create them first with:

```bash
mkdir -p ~/.config/wal/colorschemes/{dark,light}
```

2. Apply the theme using pywal:

```bash
# For dark theme
wal --theme cyberdream
# For light theme
wal --theme cyberdream-light --light
```

See the [pywal documentation](https://github.com/dylanaraps/pywal/wiki/Customization#making-your-own-colorschemes) for more information about custom colorschemes.
23 changes: 23 additions & 0 deletions extras/tilix/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Usage

### Install

1. Save the contents of either theme file:

- Dark theme: Save `cyberdream.json` to `~/.config/tilix/schemes/cyberdream.json`
- Light theme: Save `cyberdream-light.json` to `~/.config/tilix/schemes/cyberdream-light.json`

If the directory doesn't exist, create it first with:

```bash
mkdir -p ~/.config/tilix/schemes
```

2. Apply the theme through Tilix:
- Open Tilix
- Go to Preferences
- Select your profile
- Switch to the "Colors" tab
- Select either "cyberdream" or "cyberdream-light" from the Color scheme dropdown

See the [Tilix documentation](https://gnunn1.github.io/tilix-web/manual/themes/) for more information about color schemes.
File renamed without changes.
22 changes: 22 additions & 0 deletions extras/warp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Usage

### Install

1. Save the contents of either theme file:

- Dark theme: Save `cyberdream.yaml` to `~/.warp/themes/cyberdream.yaml`
- Light theme: Save `cyberdream-light.yaml` to `~/.warp/themes/cyberdream-light.yaml`

If the directory doesn't exist, create it first with:

```bash
mkdir -p ~/.warp/themes
```

2. Apply the theme through Warp:
- Open Warp
- Press `Cmd+P` (or `Ctrl+P` on Linux) to open the command palette
- Type "Open Theme Picker"
- Select either "cyberdream" or "cyberdream-light" from the available themes

See the [Warp Themes documentation](https://docs.warp.dev/appearance/custom-themes) for more information about custom themes.
31 changes: 31 additions & 0 deletions extras/windowsterminal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Usage

### Install

1. Open Windows Terminal settings (Ctrl+,) and click "Open JSON file" in the bottom left corner.

2. In the `schemes` array, add the contents of both `cyberdream.json` and `cyberdream-light.json`:

```json
{
"schemes": [
{
// ... existing schemes ...
},
{
// paste cyberdream.json contents here
},
{
// paste cyberdream-light.json contents here
}
]
}
```

3. Apply the theme:
- Open Windows Terminal Settings
- Select your profile
- Click "Appearance"
- Select either "cyberdream" or "cyberdream-light" from the "Color scheme" dropdown

See the [Windows Terminal Color Schemes documentation](https://learn.microsoft.com/en-us/windows/terminal/customize-settings/color-schemes) for more information.
32 changes: 32 additions & 0 deletions extras/zellij/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Usage

### Install

1. Save the contents of either theme file:

- Dark theme: Save `cyberdream.kdl` to `~/.config/zellij/themes/cyberdream.kdl`
- Light theme: Save `cyberdream-light.kdl` to `~/.config/zellij/themes/cyberdream-light.kdl`

If the directory doesn't exist, create it first with:

```bash
mkdir -p ~/.config/zellij/themes
```

2. Apply the theme by either:
- Adding to your `config.kdl`:
```kdl
// For dark theme
theme "cyberdream"
// Or for light theme
theme "cyberdream-light"
```
- Or launching zellij with the theme flag:
```bash
# For dark theme
zellij --theme cyberdream
# For light theme
zellij --theme cyberdream-light
```

See the [Zellij Themes documentation](https://zellij.dev/documentation/themes) for more information about custom themes.

0 comments on commit fb103ac

Please sign in to comment.