mirror of
https://github.com/ethauvin/warp-themes.git
synced 2025-04-25 09:07:11 -07:00
Updating readme's with path instructions
This commit is contained in:
parent
d7ed611acf
commit
c484f469a9
6 changed files with 163 additions and 118 deletions
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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue