From 61124246212abc8fa51f972378a0cd84c02fa477 Mon Sep 17 00:00:00 2001 From: Saltssaumure Date: Mon, 27 May 2024 00:17:04 +0100 Subject: [PATCH] Reformat readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index afbf8d2..d72cff5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[preview]: https://minidiscordthemes.github.io/Demonstration/preview/preview.png [preview-dark]: https://minidiscordthemes.github.io/Demonstration/preview/preview-dark.png [preview-light]: https://minidiscordthemes.github.io/Demonstration/preview/preview-light.png [preview-neobrutal]: https://minidiscordthemes.github.io/Demonstration/preview/preview-neobrutal.png @@ -39,23 +40,34 @@ ***A Discord theme for demonstrating Discord themes.*** -| Dark mode | Light mode | +![Demonstration banner][preview] + +| Demonstrating themes in dark mode | Demonstrating themes in light mode | | ----------------------------------------- | ------------------------------------------ | -| ![Default dark mode][preview-dark] | ![Default light mode][preview-light] | -| ![Synthesis dark mode][preview-synthesis] | ![Neobrutal light mode][preview-neobrutal] | -| ![Tritone dark mode][preview-tritone] | ![Ninex light mode][preview-ninex] | +| ![Synthesis dark mode][preview-synthesis] | ![Ninex light mode][preview-ninex] | +| ![Tritone dark mode][preview-tritone] | ![Neobrutal light mode][preview-neobrutal] | + + ## Installation +Install a client mod, then follow the instructions below. ### [BetterDiscord][BetterDiscord] +
+ Click to expand + 1. Download `Demonstration.theme.css`: - [GitHub][release-bd-gh] 2. Place the file in the themes folder: - `Settings` > `BetterDiscord` > `Themes` > `Open Themes Folder` 3. Toggle on the theme card. +
### [Replugged][Replugged] +
+ Click to expand + #### Automatic 1. Click to install: - [Replugged store][release-rp] @@ -65,8 +77,12 @@ 2. Place the file in the themes folder: - `Settings` > `Replugged` > `Themes` > `Open Themes Folder` 3. Click `Load Missing Themes` and toggle on the theme card. +
### [Vencord][Vencord] +
+ Click to expand + #### Local 1. Download `Demonstration.theme.css`: @@ -77,8 +93,10 @@ #### Online 1. Paste the link in `Settings` > `Vencord` > `Themes` > `Online Themes`: - `https://minidiscordthemes.github.io/Demonstration/Demonstration.theme.css` +
## Customisation +Follow the instructions for your client mod to edit the following variables. | Variable | Description | Valid values | Default value | | ---------------------- | ------------------------------------- | ---------------------------------- | ------------- | @@ -94,17 +112,28 @@ | `--demo-self-hue` | Hue for your own avatar | `0` to `360`. | `300` | ### BetterDiscord +
+ Click to expand + 1. Open `Settings` > `BetterDiscord` > `Themes`. 2. Click the pencil icon on this theme. 3. Edit the variable values and save changes. +
### Replugged +
+ Click to expand + 1. Enable `Automatically Apply Quick CSS` in `Settings` > `Replugged` > `General`. 2. Open `Settings` > `Replugged` > `Quick CSS`. 3. Copy and paste lines 15-27 of [`Demonstration.theme.css`][.theme.css]. 4. Edit the variable values and save. +
### Vencord +
+ Click to expand + #### Local 1. `Open Themes Folder` in `Settings` > `Vencord` > `Themes` > `Local Themes` 2. Open `Demonstration.theme.css` with your favourite text editor. @@ -113,11 +142,12 @@ 1. `Enable Custom CSS` in `Settings` > `Vencord` > `Vencord` and click `Open QuickCSS File`. 2. Copy and paste lines 15-27 of [`Demonstration.theme.css`][.theme.css]. 3. Edit the variable values. +
## License [MIT License][license] - TL;DR;NAL: Do whatever you want with this theme, just include the original license. ## Questions or suggestions? -- Post [an issue][issues] on GitHub. -- Post in `#theme-support` on [my support server][discord]. \ No newline at end of file +- [Post an issue on GitHub.][issues] +- [Post in `#theme-support` on my support server.][discord] \ No newline at end of file