Update README.md
This commit is contained in:
parent
061a823ae1
commit
d35ca5fce4
53
README.md
53
README.md
|
|
@ -1,34 +1,65 @@
|
||||||
# **Homer Theme**
|
<h1 align="center">
|
||||||

|
<img
|
||||||
|
alt="Homer Theme"
|
||||||
|
src="https://raw.githubusercontent.com/WalkxCode/Homer-Theme/main/preview.png">
|
||||||
|
<br/>
|
||||||
|
Homer Theme
|
||||||
|
</h1>
|
||||||
|
|
||||||
|
<h4 align="center">
|
||||||
|
Homer Theme is a theme for the <a href="https://github.com/bastienwirtz/homer">Homer Dashboard.</a>
|
||||||
|
</h4>
|
||||||
|
|
||||||
## Getting started with Homer Theme!
|
<p align="center">
|
||||||
|
<strong>
|
||||||
|
•
|
||||||
|
<a href="#getting-started">Getting started</a>
|
||||||
|
•
|
||||||
|
</strong>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
- [Getting Started](#getting-started)
|
||||||
|
- [Extra Configuration](docs/extra-configuration.md)
|
||||||
|
|
||||||
|
## Getting started!
|
||||||
|
|
||||||
|
Homer Theme is a theme for the [Homer Dashboard.](https://github.com/bastienwirtz/homer)
|
||||||
|
|
||||||
|
### Making sure your Homer is on Darkmode
|
||||||
|
|
||||||
### 1. Making sure your Homer is on Darkmode
|
|
||||||
On the top-right of Homer, you can find an icon to toggle dark-mode. Click it until the UI turns dark, and the icon looks like an empty circle!
|
On the top-right of Homer, you can find an icon to toggle dark-mode. Click it until the UI turns dark, and the icon looks like an empty circle!
|
||||||
|
|
||||||
### 2. Getting the assets files
|
**Homer Theme will NOT work when using lightmode.**
|
||||||
**Clone [this repo](https://github.com/WalkxCode/Homer-Theme). You can do this by running:**
|
|
||||||
|
|
||||||
|
### Getting the assets folder
|
||||||
|
|
||||||
|
Clone [this repo](https://github.com/WalkxCode/Homer-Theme). You can do this by running:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ git clone https://github.com/WalkxCode/Homer-Theme.git
|
$ git clone https://github.com/WalkxCode/Homer-Theme.git
|
||||||
```
|
```
|
||||||
**Now cd into the newly created folder.**
|
|
||||||
|
Now cd into the newly created folder.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ cd Homer-Theme
|
$ cd Homer-Theme
|
||||||
```
|
```
|
||||||
**And now for the final step move the `assets` folder into your Homers `www` folder.**
|
|
||||||
|
|
||||||
|
And now for the final step move the `assets` folder into your Homers `www` folder.
|
||||||
You can find this directory by running
|
You can find this directory by running
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ sudo docker inspect -f '{{ .Mounts }}' homer
|
$ sudo docker inspect -f '{{ .Mounts }}' homer
|
||||||
```
|
```
|
||||||
|
|
||||||
**Move the folder by running**
|
Move the folder by running
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ sudo mv assets /homer/www
|
$ sudo mv assets /homer/www
|
||||||
```
|
```
|
||||||
_Make sure you replace `/homer/www` with the location of **your** www folder._
|
_Make sure you replace `/homer/www` with the location of **your** www folder._
|
||||||
|
|
||||||
### 3. Go to your Homers IP and port and see the result!
|
|
||||||
|
|
||||||
#### To further customize the Dashboard, see the [Wiki](https://github.com/WalkxCode/Homer-Theme/wiki)!
|
### Go to your Homers IP and port and see the result!
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue