chinwag/ChinwagUI
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Niléane 2023-07-10 21:12:46 +02:00
parent 82af2f2b25
commit 569d356273
No known key found for this signature in database
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -8,14 +8,18 @@ Turn your Mastodon web UI into a friendlier place. Tangerine features a soft ora
## How to use
**Tangerine UI is contained in a single CSS file.**
To use on your instance, simply copy & paste the contents of [TangerineUI-single-colum.css](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUIforMastodon-singlecolumnlayout.css) to the **Custom CSS** field in the administration panel on your Mastodon instance (Navigate to https://*your instance domain*/admin/settings/appearance).
If you're not an admin, you can still use Tangerine UI using a userstyle browser extension (ie. Stylish).
### Things to know
* This is still pretty early. Things might not be styled properly in some places. Feel free to message me if you notice anything wonky!
* **Tangerine UI only supports the single column layout for now**. The advanced view will not be affected.
* This is still pretty early, I'm not a professional designer, and this is a personal project, so things might not be styled properly in some places. Feel free to message me if you notice anything wonky though :)
* **Tangerine UI currently only supports the single column layout**. The advanced view (multiple columns) will not be affected.
* **Tangerine UI auto-switches from light to dark mode based on your OS preference**, whether you set your Mastodon theme to *Mastodon (Dark)* or *Mastodon (Light*).
* Check your Mastodon instance version before using. The latest Mastodon release checked to be compatible is indicated in the CSS file header.
* Glitch-soc and Hometown instance admins beware: Tangerine UI is currently only meant to be applied to Mastodon's vanilla Dark and Light theme.
* I have not yet adapted Tangerine to Mastodon's *High Contrast* theme setting. Please consider this if one or multiple of your users depend on it.
## Credits
Huge thanks to [Roni Laukkarinen](https://mementomori.social/@rolle) whose work on [Mastodon Bird UI](https://github.com/ronilaukkarinen/mastodon-bird-ui) I adapted for multiple parts of the redesign. The icon replacement implementations I have also adapted from Bird UI.