mirror of
https://github.com/ethauvin/warp-themes.git
synced 2025-04-25 01:07:10 -07:00
Updating readme's with path instructions
This commit is contained in:
elvis kahoro
parent
d7ed611acf
commit
c484f469a9
6 changed files with 163 additions and 118 deletions
|
|
@ -2,28 +2,45 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
## Custom Background Images
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
If want to use a custom background image, Warp supports either:
|
||||
|
||||
## Credits
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If a theme has a custom background image included, we include the author and site that the image was originally hosted in the yaml associated with the image, e.g. the dark_city_bg.jpg credits the author in the dark_city.yaml (a comment next to background image).
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
### Open source dependencies
|
||||
```yaml
|
||||
background_image:
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:
|
||||
|
||||
- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
- [base16](https://github.com/chriskempson/base16)
|
||||
- [Solarized](https://ethanschoonover.com/solarized/)
|
||||
- [Dracula](https://draculatheme.com/)
|
||||
- [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
* [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
* [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
* [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
* [base16](https://github.com/chriskempson/base16)
|
||||
* [Solarized](https://ethanschoonover.com/solarized/)
|
||||
* [Dracula](https://draculatheme.com/)
|
||||
* [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
|
||||
## What are base16 themes?
|
||||
|
||||
|
|
@ -34,20 +51,9 @@ More on the details and structure here: [https://github.com/chriskempson/base16.
|
|||
Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill.
|
||||
Repo: [https://github.com/aarowill/base16-alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
|
||||
## What are holiday themes?
|
||||
|
||||
We made holiday themes to celebrate various holidays during the calendar year.
|
||||
|
||||
## What are standard themes?
|
||||
|
||||
In this directory you'll find themes popular among other tools, including Solarized, Dracula and others.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
||||
## What are warp_bundled themes?
|
||||
|
||||
In this directory you'll find the themes that Warp ships with by default, including their custom backgrounds.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
|
|
|||
21
README.md
21
README.md
|
|
@ -2,18 +2,33 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
## Custom Background Images
|
||||
|
||||
If want to use a custom background image, Warp supports either:
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
```yaml
|
||||
background_image:
|
||||
# background image credit: https://unsplash.com/photos/0eKCOZ11gfk
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
|
|
|
|||
|
|
@ -2,28 +2,45 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
## Custom Background Images
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
If want to use a custom background image, Warp supports either:
|
||||
|
||||
## Credits
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If a theme has a custom background image included, we include the author and site that the image was originally hosted in the yaml associated with the image, e.g. the dark_city_bg.jpg credits the author in the dark_city.yaml (a comment next to background image).
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
### Open source dependencies
|
||||
```yaml
|
||||
background_image:
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:
|
||||
|
||||
- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
- [base16](https://github.com/chriskempson/base16)
|
||||
- [Solarized](https://ethanschoonover.com/solarized/)
|
||||
- [Dracula](https://draculatheme.com/)
|
||||
- [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
* [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
* [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
* [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
* [base16](https://github.com/chriskempson/base16)
|
||||
* [Solarized](https://ethanschoonover.com/solarized/)
|
||||
* [Dracula](https://draculatheme.com/)
|
||||
* [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
|
||||
## What are base16 themes?
|
||||
|
||||
|
|
@ -34,21 +51,10 @@ More on the details and structure here: [https://github.com/chriskempson/base16.
|
|||
Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill.
|
||||
Repo: [https://github.com/aarowill/base16-alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
|
||||
## What are holiday themes?
|
||||
|
||||
We made holiday themes to celebrate various holidays during the calendar year.
|
||||
|
||||
## What are standard themes?
|
||||
|
||||
In this directory you'll find themes popular among other tools, including Solarized, Dracula and others.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
||||
## What are warp_bundled themes?
|
||||
|
||||
In this directory you'll find the themes that Warp ships with by default, including their custom backgrounds.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|Theme name | Preview|
|
||||
|
|
|
|||
|
|
@ -2,28 +2,45 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
## Custom Background Images
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
If want to use a custom background image, Warp supports either:
|
||||
|
||||
## Credits
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If a theme has a custom background image included, we include the author and site that the image was originally hosted in the yaml associated with the image, e.g. the dark_city_bg.jpg credits the author in the dark_city.yaml (a comment next to background image).
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
### Open source dependencies
|
||||
```yaml
|
||||
background_image:
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:
|
||||
|
||||
- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
- [base16](https://github.com/chriskempson/base16)
|
||||
- [Solarized](https://ethanschoonover.com/solarized/)
|
||||
- [Dracula](https://draculatheme.com/)
|
||||
- [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
* [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
* [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
* [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
* [base16](https://github.com/chriskempson/base16)
|
||||
* [Solarized](https://ethanschoonover.com/solarized/)
|
||||
* [Dracula](https://draculatheme.com/)
|
||||
* [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
|
||||
## What are base16 themes?
|
||||
|
||||
|
|
@ -34,21 +51,10 @@ More on the details and structure here: [https://github.com/chriskempson/base16.
|
|||
Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill.
|
||||
Repo: [https://github.com/aarowill/base16-alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
|
||||
## What are holiday themes?
|
||||
|
||||
We made holiday themes to celebrate various holidays during the calendar year.
|
||||
|
||||
## What are standard themes?
|
||||
|
||||
In this directory you'll find themes popular among other tools, including Solarized, Dracula and others.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
||||
## What are warp_bundled themes?
|
||||
|
||||
In this directory you'll find the themes that Warp ships with by default, including their custom backgrounds.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|Theme name | Preview|
|
||||
|
|
|
|||
|
|
@ -2,28 +2,45 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
## Custom Background Images
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
If want to use a custom background image, Warp supports either:
|
||||
|
||||
## Credits
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If a theme has a custom background image included, we include the author and site that the image was originally hosted in the yaml associated with the image, e.g. the dark_city_bg.jpg credits the author in the dark_city.yaml (a comment next to background image).
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
### Open source dependencies
|
||||
```yaml
|
||||
background_image:
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:
|
||||
|
||||
- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
- [base16](https://github.com/chriskempson/base16)
|
||||
- [Solarized](https://ethanschoonover.com/solarized/)
|
||||
- [Dracula](https://draculatheme.com/)
|
||||
- [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
* [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
* [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
* [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
* [base16](https://github.com/chriskempson/base16)
|
||||
* [Solarized](https://ethanschoonover.com/solarized/)
|
||||
* [Dracula](https://draculatheme.com/)
|
||||
* [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
|
||||
## What are base16 themes?
|
||||
|
||||
|
|
@ -34,21 +51,10 @@ More on the details and structure here: [https://github.com/chriskempson/base16.
|
|||
Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill.
|
||||
Repo: [https://github.com/aarowill/base16-alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
|
||||
## What are holiday themes?
|
||||
|
||||
We made holiday themes to celebrate various holidays during the calendar year.
|
||||
|
||||
## What are standard themes?
|
||||
|
||||
In this directory you'll find themes popular among other tools, including Solarized, Dracula and others.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
||||
## What are warp_bundled themes?
|
||||
|
||||
In this directory you'll find the themes that Warp ships with by default, including their custom backgrounds.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|Theme name | Preview|
|
||||
|
|
|
|||
|
|
@ -2,28 +2,45 @@
|
|||
|
||||
This is an open source repository with themes for [Warp](https://www.warp.dev/).
|
||||
We welcome and appreciate any contributions!
|
||||
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
|
||||
|
||||
We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
|
||||
|
||||
[Discord](https://discord.gg/warpdotdev)
|
||||
## Custom Background Images
|
||||
|
||||
[Warp Repo](https://github.com/warpdotdev/Warp)
|
||||
If want to use a custom background image, Warp supports either:
|
||||
|
||||
## Credits
|
||||
* a relative path to `~/.warp/themes`
|
||||
* the absolute path to the background image
|
||||
|
||||
If a theme has a custom background image included, we include the author and site that the image was originally hosted in the yaml associated with the image, e.g. the dark_city_bg.jpg credits the author in the dark_city.yaml (a comment next to background image).
|
||||
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then the filepath in the yaml should be:
|
||||
|
||||
### Open source dependencies
|
||||
```yaml
|
||||
background_image:
|
||||
path: level_one/level_two/background_image.jpg
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
|
||||
|
||||
`python3 ./scripts/gen_theme_previews.py standard`
|
||||
|
||||
for a newly added theme that's in the standard folder / directory. If you get the error that yaml is missing make sure you `pip install PyYAML`
|
||||
|
||||
There are more [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).
|
||||
|
||||
## Open source dependencies
|
||||
|
||||
We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:
|
||||
|
||||
- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
- [base16](https://github.com/chriskempson/base16)
|
||||
- [Solarized](https://ethanschoonover.com/solarized/)
|
||||
- [Dracula](https://draculatheme.com/)
|
||||
- [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
* [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
|
||||
* [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
* [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
* [base16](https://github.com/chriskempson/base16)
|
||||
* [Solarized](https://ethanschoonover.com/solarized/)
|
||||
* [Dracula](https://draculatheme.com/)
|
||||
* [Gruvbox](https://github.com/morhetz/gruvbox)
|
||||
|
||||
## What are base16 themes?
|
||||
|
||||
|
|
@ -34,21 +51,10 @@ More on the details and structure here: [https://github.com/chriskempson/base16.
|
|||
Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill.
|
||||
Repo: [https://github.com/aarowill/base16-alacritty](https://github.com/aarowill/base16-alacritty)
|
||||
|
||||
## What are holiday themes?
|
||||
|
||||
We made holiday themes to celebrate various holidays during the calendar year.
|
||||
|
||||
## What are standard themes?
|
||||
|
||||
In this directory you'll find themes popular among other tools, including Solarized, Dracula and others.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|
||||
## What are warp_bundled themes?
|
||||
|
||||
In this directory you'll find the themes that Warp ships with by default, including their custom backgrounds.
|
||||
|
||||
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy.
|
||||
Repo: [https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
||||
|Theme name | Preview|
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue