Skip to content

Commit 332617a

Browse files
committed
improve readme
1 parent 73a1948 commit 332617a

File tree

1 file changed

+64
-21
lines changed

1 file changed

+64
-21
lines changed

README.md

Lines changed: 64 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,85 @@
1-
# synthwave-hass
1+
# Synthwave-Hass
22

33
[![Version](https://img.shields.io/badge/version-0.3.6-green.svg?style=flat-square&labelColor=2a2139&color=f92aad)](#)
4-
[![maintained](https://img.shields.io/maintenance/no/2020.svg?style=flat-square&labelColor=2a2139&color=f92aad)](#)
5-
[![prs](https://img.shields.io/badge/accepting%20PR's-yes-x?style=flat-square&labelColor=2a2139&color=f92aad)](#)
4+
[![Maintained](https://img.shields.io/maintenance/no/2020.svg?style=flat-square&labelColor=2a2139&color=f92aad)](#)
5+
[![PRs Accepted](https://img.shields.io/badge/accepting%20PR's-yes-x?style=flat-square&labelColor=2a2139&color=f92aad)](#)
66

7-
## This project is no longer supported
7+
## Project Status
88

9-
In addition to Home Assistant now supporting a limited amount of theme customizability through Lovelace, rendering this theme partly useless, I have lost interest and time for this project. This theme will no longer be developed by me. However, I will still be accepting pull requests, after review, if anyone submits any fixes.
9+
**This project is no longer supported.**
10+
11+
Due to Home Assistant now supporting limited theme customization through Lovelace, this theme has become partially redundant. Additionally, I have lost the time and interest to maintain this project further. However, I will still review and accept pull requests for any fixes or improvements submitted by the community.
1012

1113
---
1214

13-
> Do you remember that endless summer back in '84? Cruising down the ocean-highway with the top down, the wind in our hair and heads buzzing with neon dreams?
15+
> "Do you remember that endless summer back in '84? Cruising down the ocean highway with the top down, the wind in our hair and heads buzzing with neon dreams?"
16+
>
17+
> No? Well, neither do I, but with this experimental theme, we can pretend to go there.
1418
15-
> No, I don't remember it either, but with this experimental theme we can go there.
19+
Inspired by: [Synthwave VSCode Theme](https://github.com/robb0wen/synthwave-vscode)
1620

17-
> https://github.com/robb0wen/synthwave-vscode
21+
---
1822

1923
## Installation
2024

21-
* Find your homeassistant directory containing your configuration (let's say `~/.homeassistant/`)
22-
* Change into `~/.homeassistant/themes` (create the `themes` directory, if it does not exist, you then might have to restart HA)
23-
* `$ wget https://raw.githubusercontent.com/bbbenji/synthwave-hass/master/themes/synthwave.yaml` downloads the `.yaml` file directly where it should reside
24-
* Make sure Home Assistant knows about your new theme file by adding the following to your `configuration.yaml`
25-
``` yaml
25+
### Step 1: Locate Your Home Assistant Directory
26+
27+
Find the directory containing your Home Assistant configuration. This is typically located at `~/.homeassistant/`.
28+
29+
### Step 2: Add the Theme
30+
31+
1. Navigate to the `themes` directory:
32+
```bash
33+
cd ~/.homeassistant/themes
34+
```
35+
2. If the `themes` directory does not exist, create it:
36+
37+
```bash
38+
mkdir themes
39+
```
40+
41+
After creating the directory, you may need to restart Home Assistant.
42+
43+
3. Download the theme file directly:
44+
```bash
45+
wget https://raw.githubusercontent.com/bbbenji/synthwave-hass/master/themes/synthwave.yaml
46+
```
47+
48+
### Step 3: Update Configuration
49+
50+
Add the following lines to your `configuration.yaml` file to ensure Home Assistant recognizes the new theme:
51+
52+
```yaml
2653
frontend:
2754
themes: !include_dir_merge_named themes
2855
```
29-
* Finally enable the theme from your profile page or `configuration.yaml`
3056
31-
**Extras**
32-
Optionally you can install [synthwave-hass-extras](https://github.com/bbbenji/synthwave-hass-extras) which adds some additional styling not possible using the a .yaml theme file.
57+
### Step 4: Enable the Theme
3358
34-
**Screenshots**
59+
You can enable the theme from your profile page or by configuring it directly in `configuration.yaml`.
3560

36-
![1](https://i.imgur.com/DHbESc9.png)
61+
---
3762

38-
![2](https://i.imgur.com/bLhZFHy.png)
63+
## Extras
64+
65+
For additional styling that is not achievable with a `.yaml` theme file, you can install [synthwave-hass-extras](https://github.com/bbbenji/synthwave-hass-extras).
66+
67+
---
68+
69+
## Screenshots
70+
71+
Here are some visuals to get a feel for the theme:
72+
73+
![Screenshot 1](https://i.imgur.com/DHbESc9.png)
74+
75+
![Screenshot 2](https://i.imgur.com/bLhZFHy.png)
76+
77+
![Screenshot 3](https://i.imgur.com/BcyjeJz.png)
78+
79+
![Screenshot 4](https://i.imgur.com/WXg2417.png)
80+
81+
---
3982

40-
![3](https://i.imgur.com/BcyjeJz.png)
83+
## Contributions
4184

42-
![3](https://i.imgur.com/WXg2417.png)
85+
While this project is no longer actively maintained, contributions are welcome! If you find any issues or have improvements to suggest, feel free to submit a pull request. Let's keep the Synthwave spirit alive together!

0 commit comments

Comments
 (0)