actually finish the readme

DONEEEEEEEEE
This commit is contained in:
Charles Wang 2023-01-09 20:23:50 -05:00 committed by GitHub
parent ebb0c0d54e
commit d5fc1dc237
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -27,6 +27,7 @@ for Arch users, the theme is available from the AUR [here](https://aur.archlinux
### manually
on other distros, simply download/clone this repo, and copy the `corners/` folder to `/usr/share/sddm/themes/`.
```
git clone https://github.com/aczw/sddm-theme-corners.git
cd sddm-theme-corners
@ -35,12 +36,76 @@ cp -r corners/ /usr/share/sddm/themes/
## configuration
if you haven't already, make sure to change the current theme that SDDM is using. on Arch, create a config file in `/etc/sddm.conf.d/` with the following contents:
```
[Theme]
Current=corners
```
check the [Arch Wiki](https://wiki.archlinux.org/title/SDDM#Configuration) for more info.
you will probably want to configure the theme before using it, as out of the box it uses [Atkinson Hyperlegible](https://fonts.google.com/specimen/Atkinson+Hyperlegible) as the display font, and assumes a screen DPI of 216 (basically, my setup :p).
edit the `theme.conf` file (located inside `corners/`) as you see fit. I tried to make most stuff customizable, but please lemme know if you want other options too. here's a short description of what each option does:
edit the `theme.conf` file (located inside `corners/`) as you see fit. I tried to make most stuff customizable, but please lemme know if you want other options too. the following are short descriptions of what each option does.
*note that colors require the leading `#` and that all options have to be wrapped in quotation marks. refer to [this](https://doc.qt.io/qt-5/qml-color.html) link for more info regarding colors.*
### general
- `Background`: path to the wallpaper. you can drop files in `backgrounds/` to use a relative path, or you can just use an absolute path.
- `Font`: the font to use throughout the theme. use the name of the font family.
- `Padding`: the distance that stuff should be from the screen edge.
- `CornerRadius`: specify how round corners should be, or set to 0 to disable rounded corners.
- `GeneralFontSize`: the font size used for everything excluding the date and time.
- `LoginScale`: this allows you to adjust the relative scale of UI elements. you should probably keep the value below 1.
### user picture
click on the avatar to change users!
- `UserPictureBorderWidth`: the width of the outline around the user avatar. set to 0 to disable.
- `UserPictureBorderColor`: the color of the outline around the user avatar.
- `UserPictureColor`: the color of the default, blank avatar. note that this is only visible when you don't have a custom picture set.
### text field (user and password)
- `TextFieldColor`: the color of the text field background for the user and password fields.
- `TextFieldTextColor`: the color of the text inside the user and password fields.
### login button
- `LoginButtonTextColor`: the color of the login button text.
- `LoginButtonBgColor`: the color of the login button background.
### popup (power, session, and user)
- `PopupBgColor`: the background color of the popup. this applies to the power panel, session panel, and user panel.
- `PopupHighlightColor`: the color of the currently selected entry in the popup. this applies to the power panel, session panel, and user panel.
### session button
- `SessionButtonColor`: the color of the session button background.
- `SessionIconColor`: the color of the icon inside the session button.
### power button
- `PowerButtonColor`: the color of the power button background.
- `PowerIconColor`: the color of the icon inside the session button.
### date
- `DateColor`: the text color of the date.
- `DateSize`: the font size of the date.
- `DateIsBold`: whether the date is bolded. accepts either `true` or `false`.
- `DateOpacity`: the opacity of the date text. set to 1 to disable transparency.
- `DateFormat`: specify the formatting of the date.
### time
- `TimeColor`: the text color of the time.
- `TimeSize`: the font size of the time.
- `TimeIsBold`: whether the time is bolded. accepts either `true` or `false`.
- `TimeOpacity`: the opacity of the time text. set to 1 to disable transparency.
- `TimeFormat`: specify the formatting of the time.
that's pretty much it. I hope you enjoy the theme. feedback is much appreciated :)