Skip to content

Commit

Permalink
πŸ“ update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yozachar committed Apr 16, 2024
1 parent 06e91f6 commit 241f696
Showing 1 changed file with 20 additions and 44 deletions.
64 changes: 20 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,70 +10,46 @@ A sleek boot-up progress bar for Arch Linux

Follow instructions on ArchWiki to install and setup [Plymouth](https://wiki.archlinux.org/title/plymouth).

🐧 **AUR**

```bash
➜ yay -S plymouth-theme-aregression
```

πŸ™Œ **Manual**

- Clone this repository:

```bash
➜ sudo git clone https://github.com/joe733/aregression /usr/share/plymouth/themes/aregression
```

## Usage

This is well documented in the same ArchWiki page. Nevertheless you can execute the following commands:

- List all themes

```bash
➜ sudo plymouth-set-default-theme -l # You should see aregression listed
```
```bash
# Clone this repository:
$ git clone https://github.com/joe733/plymouth-theme-aregression.git aregression

- Change theme test theme
# You should see aregression listed
$ sudo plymouth-set-default-theme -l

```bash
➜ sudo plymouth-set-default-theme aregression
➜ sudo plymouthd # Start plymouthd
➜ sudo plymouth --show-splash # ⚠️ Use Ctrl + Alt + F7 df/ to quit
➜ sudo plymouth --quit # Quit plymouthd
```
# Change plymouth theme
$ sudo plymouth-set-default-theme -R aregression
```

- If everything is fine update initramfs
🐧 **AUR**

```bash
➜ sudo plymouth-set-default-theme -R aregression
# OR
➜ mkinitcpio -P
```
```bash
➜ yay -S plymouth-theme-aregression
```

## Removal

🐧 **AUR**

```bash
yay -Rs plymouth-theme-aregression # ⚠️ Perform manual removal after this
# Perform manual removal after this
$ yay -Rs plymouth-theme-aregression
```

πŸ™Œ **Manual**

- Remove the theme folder

```bash
➜ sudo mv /usr/share/plymouth/themes/aregression ~/
➜ sudo rm -rf ~/aregression # ⚠️ Dangerous command! Double check your directory
```
```bash
# Dangerous command! Double check your directory/path
$ sudo rm -rf /usr/share/plymouth/themes/aregression
```

## Troubleshooting

- Double check if you've followed the steps mentioned in the [ArchWiki](https://wiki.archlinux.org/title/plymouth) to install Plymouth
- Make sure that your login manager has the Plymouth daemon enabled, see ArchWiki on how to do it.
- It's known that lower screen resolution have scaling issue. For now it works well with 1920 x 1080 displays. I'm working on it.
- Try using installing a grub theme, and see if any graphic driver is causing resolution issues. Related: https://askubuntu.com/questions/362722/how-to-fix-plymouth-splash-screen-in-all-ubuntu-releases
- It's known that lower screen resolution has scaling issue. For now it works well with `1920 x 1080` displays. I'm working on it.
- Try using installing a grub theme, and see if any graphic driver is causing resolution issues. Related: <https://askubuntu.com/questions/362722/how-to-fix-plymouth-splash-screen-in-all-ubuntu-releases/>
- Does your grub file contains this line `GRUB_CMDLINE_LINUX_DEFAULT="quiet splash"`?
- If nothing works create an [issue](https://github.com/joe733/plymouth-theme-aregression/issues).

Expand Down

0 comments on commit 241f696

Please sign in to comment.