From d35ca5fce45bb78697b73fe72eb2cdfa847c5b7b Mon Sep 17 00:00:00 2001 From: Walkx <71191962+WalkxCode@users.noreply.github.com> Date: Sat, 16 Oct 2021 19:40:07 +0200 Subject: [PATCH] Update README.md --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 42 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 49cd642..e48a49c 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,65 @@ -# **Homer Theme** -![img](https://raw.githubusercontent.com/WalkxCode/Homer-Theme/main/preview.png?token=AQ7E3GREVKRKTQCF7RDD6CTBORDCY) +

+ Homer Theme +
+ Homer Theme +

+

+ Homer Theme is a theme for the Homer Dashboard. +

-## Getting started with Homer Theme! +

+ + • + Getting started + • + +

+ +## 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! -### 2. Getting the assets files -**Clone [this repo](https://github.com/WalkxCode/Homer-Theme). You can do this by running:** +**Homer Theme will NOT work when using lightmode.** + + +### Getting the assets folder + +Clone [this repo](https://github.com/WalkxCode/Homer-Theme). You can do this by running: + ```sh $ git clone https://github.com/WalkxCode/Homer-Theme.git ``` -**Now cd into the newly created folder.** + +Now cd into the newly created folder. + ```sh $ 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 + ```sh $ sudo docker inspect -f '{{ .Mounts }}' homer ``` -**Move the folder by running** +Move the folder by running + ```sh $ sudo mv assets /homer/www ``` _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!