From c1e5924f90f70f565583142d275e3e8fc9c69d2e Mon Sep 17 00:00:00 2001
From: Norwin Roosen <git@nroo.de>
Date: Fri, 30 Jul 2021 12:10:03 +0200
Subject: [PATCH] document & simplify deployment as gitea theme

---
 Gitea/readme.md                               | 33 +++++++++++++------
 ...rn-compiled.css => theme-gitea-modern.css} |  0
 ...tea-modern.css => theme-gitea-modern.less} |  0
 ...n.user.css => theme-gitea-modern.user.css} |  4 +--
 4 files changed, 25 insertions(+), 12 deletions(-)
 rename Gitea/{Gitea-modern-compiled.css => theme-gitea-modern.css} (100%)
 rename Gitea/{Gitea-modern.css => theme-gitea-modern.less} (100%)
 rename Gitea/{Gitea-modern.user.css => theme-gitea-modern.user.css} (96%)

diff --git a/Gitea/readme.md b/Gitea/readme.md
index ed500ed..ce3600c 100644
--- a/Gitea/readme.md
+++ b/Gitea/readme.md
@@ -4,17 +4,30 @@
 
 This style changes the layout of Gitea, and uses Gitea's color variables. It can be used with any theme that changes only colors.
 
-Using 
-[`Gitea-modern.css`](Gitea-modern.css) 
-requires a preprocessor that supports CSS nesting, like 'Stylus' (recommended) or 'Less'. 
+### Disclaimer
+**I don't know if everything is properly polished, and the style is still being worked on. If you find an issue with the style, please create an issue. Or if you can fix an issue yourself, create a pull request!**
 
-Or you can use the already compiled version, 
-[`Gitea-modern-compiled.css`](Gitea-modern-compiled.css) 
-instead.
+### Usage as Gitea theme
+To install the theme for all Gitea users:
 
-When making contributions, don't use the compiled version.
+1. Download the [`theme-gitea-modern.css` file][theme-file] and add it to your custom folder in `$GITEA_CUSTOM/public/css/` ([learn how to find that directory][doc-dir]).
+  - The path has changed in Gitea 1.15, there the file needs to be placed in `$GITEA_CUSTOM/public/assets/css`
+2. Adapt your `app.ini` to make it the default theme or be user-selectable:
+    - To change the default theme, change the value of `DEFAULT_THEME` in the [ui section][doc-config] of `app.ini` to `gitea-modern`
 
-I've never hosted a Gitea instance before so I have no idea how to apply it.
-If you use the Stylus browser extension, you can use the [`Gitea-modern.user.css`](https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/Gitea-modern.user.css) file instead to apply to any Gitea instance.
+    - To make a theme selectable by users in their profile settings, append `,gitea-modern` to the list of `THEMES` in your `app.ini`.
+3. Restart Gitea
+4. Enjoy :)
 
-**I don't know if everything is properly polished, and the style is still being worked on. If you find an issue with the style, please create an issue. Or if you can fix an issue yourself, create a pull request!**
\ No newline at end of file
+
+### Usage with Stylus
+If you use the Stylus browser extension, you can use the [`theme-gitea-modern.user.css`][usertheme-file]) file to apply to any Gitea instance.
+
+### Contributing
+To make changes, always base them on [`theme-gitea-modern.less`](theme-gitea-modern.less), which is written for any CSS preprocessor that supports CSS nesting, like 'Stylus' (recommended) or 'Less'.
+When making contributions, don't use the compiled version for your changes.
+
+[theme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.css
+[usertheme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.user.css
+[doc-config]: https://docs.gitea.io/en-us/config-cheat-sheet/#ui-ui
+[doc-dir]: https://docs.gitea.io/en-us/faq/#where-does-gitea-store-what-file
diff --git a/Gitea/Gitea-modern-compiled.css b/Gitea/theme-gitea-modern.css
similarity index 100%
rename from Gitea/Gitea-modern-compiled.css
rename to Gitea/theme-gitea-modern.css
diff --git a/Gitea/Gitea-modern.css b/Gitea/theme-gitea-modern.less
similarity index 100%
rename from Gitea/Gitea-modern.css
rename to Gitea/theme-gitea-modern.less
diff --git a/Gitea/Gitea-modern.user.css b/Gitea/theme-gitea-modern.user.css
similarity index 96%
rename from Gitea/Gitea-modern.user.css
rename to Gitea/theme-gitea-modern.user.css
index 55e1b86..2d07cad 100644
--- a/Gitea/Gitea-modern.user.css
+++ b/Gitea/theme-gitea-modern.user.css
@@ -28,5 +28,5 @@
 
 
 @-moz-document domain("codeberg.org"), domain("gitea.com"), domain("try.gitea.io"), domain("gitdab.com"), domain("git.fsfe.org"), domain("git.passageenseine.fr"), domain("dev.sum7.eu") {
-	@import url("https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/Gitea-modern-compiled.css");
-}
\ No newline at end of file
+	@import url("https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.css");
+}