Readme update

LeonMarcel-HD · Jun 22, 2021 · 41dd46f · 41dd46f
1 parent 705e4e9
commit 41dd46f
Show file tree

Hide file tree

Showing 18 changed files with 77 additions and 33 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Leon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Pictures/Bubbles.png b/Pictures/Bubbles.png
diff --git a/Pictures/Cyan.png b/Pictures/Cyan.png
diff --git a/Pictures/CyanSpeak.png b/Pictures/CyanSpeak.png
diff --git a/Pictures/Download.png b/Pictures/Download.png
diff --git a/Pictures/Fav.png b/Pictures/Fav.png
diff --git a/Pictures/Green.png b/Pictures/Green.png
diff --git a/Pictures/GreenSpeak.png b/Pictures/GreenSpeak.png
diff --git a/Pictures/Orange.png b/Pictures/Orange.png
diff --git a/Pictures/OrangeSpeak.png b/Pictures/OrangeSpeak.png
diff --git a/Pictures/Pink.png b/Pictures/Pink.png
diff --git a/Pictures/PinkSpeak.png b/Pictures/PinkSpeak.png
diff --git a/Pictures/Red.png b/Pictures/Red.png
diff --git a/Pictures/RedSpeak.png b/Pictures/RedSpeak.png
diff --git a/Pictures/Title.png b/Pictures/Title.png
diff --git a/Pictures/Yellow.png b/Pictures/Yellow.png
diff --git a/Pictures/YellowSpeak.png b/Pictures/YellowSpeak.png
diff --git a/README.adoc b/README.adoc
@@ -10,10 +10,8 @@ endif::[]
 
 :toc: left
 :idseparator: -
-ifdef::env-github,safe-mode-secure[]
 :toc:
 :toc-placement!:
-endif::[]
 
 ifdef::env-github,safe-mode-secure[]
 toc::[]
@@ -24,16 +22,23 @@ ifdef::env-github[]
 endif::[]
 
 '''
-
 ⠀
+ifdef::env-github[]
+++++
+<p align="center">
+  <img src="https://raw.githubusercontent.com/LeonMarcel-HD/Colorful-Teamspeak-Themes/main/Pictures/Title.png">
+</p>
+++++
+endif::[]
 
+ifndef::env-github[]
 image::Pictures\Title.png[Colorful TeamSpeak Theme, align=center]
-
+endif::[]
 ⠀
 
 '''
 
-This theme…
+= This theme…
 
 * changes the default color of TeamSpeak to the selected color
 
@@ -46,64 +51,82 @@ image:Pictures\Bubbles.png[No Bubbles in Chat]
 
 
 image:Pictures\Fav.png[Favorite Star in Contact List]
-⠀
 
 '''
 
-image:Pictures\CyanSpeak.png[CyanSpeak]
+= image:Pictures\Cyan.png[Cyan]
 
-image:Pictures\Cyan.png[Cyan]
-⠀
+'''
+
+= image:Pictures\Green.png[Green]
 
 '''
 
-⠀
-image:Pictures\GreenSpeak.png[GreenSpeak]
+= image:Pictures\Orange.png[Orange] 
 
-image:Pictures\Green.png[Green]
-⠀
+'''
+
+= image:Pictures\Yellow.png[Yellow] 
 
 '''
 
-⠀
-image:Pictures\OrangeSpeak.png[OrangeSpeak]
+= image:Pictures\Pink.png[Pink] 
 
-image:Pictures\Orange.png[Orange] 
-⠀
+'''
+
+= image:Pictures\Red.png[Red]
 
 '''
 
 ⠀
-image:Pictures\YellowSpeak.png[YellowSpeak]
+ifdef::env-github[]
+++++
+<p align="center">
+  <img src="https://raw.githubusercontent.com/LeonMarcel-HD/Colorful-Teamspeak-Themes/main/Pictures/Download.png">
+</p>
+++++
+endif::[]
 
-image:Pictures\Yellow.png[Yellow] 
-⠀
+ifndef::env-github[]
+image::Pictures\Download.png[Download and Installation, align=center]
+endif::[]
 
-'''
 ⠀
 
-image:Pictures\PinkSpeak.png[PinkSpeak]
+= Automatic Installation
 
-image:Pictures\Pink.png[Pink] 
-⠀
+ * Download the https://github.com/LeonMarcel-HD/Colorful-Teamspeak-Themes/releases/latest/download/installer[Installer] and execute it.
 
-'''
-⠀
+ * Go trough the "Installation" process.
 
-image:Pictures\RedSpeak.png[RedSpeak]
+ * Restart or open TeamSpeak.
 
-image:Pictures\Red.png[Red] 
-⠀
+ * Go into the `Settings -> Apperance -> User Theme` and here you can select the theme typ you want to use.
 
-'''
-⠀
+= Manual Installation
+
+ * Download the https://github.com/LeonMarcel-HD/Colorful-Teamspeak-Themes/releases/latest/download/de.leonmarcelhd.colorfulteamspeak[Theme] and move it into the Extentions folder:
+
+> Windows: %appdata%\TeamSpeak\Default\extensions
+
+> Linux: ~/.config/TeamSpeak/Default/extensions
 
-image::Pictures\Download.png[Download, align=center]
+> Mac: ~/Library/Preferences/TeamSpeak/Default/extensions
 
+NOTE: Default stands for you Profile and might be different in your TeamSpeak Installation!
+
+ * Restart or open TeamSpeak.
+
+ * Go into the `Settings -> Apperance -> User Theme` and here you can select the theme typ you want to use.
 ⠀
 
 '''
 
 ⠀
+Special thanks to Gamer92000 for helping me creating these themes.
+
+-> https://github.com/Gamer92000[GitHub]
+
+-> https://community.teamspeak.com/u/gamer92000[TeamSpeak Forum]
 
-Special thanks to @Gamer92000 for helping me creating these themes.
+'''