Skip to content

Commit

Permalink
update all the doc and the img
Browse files Browse the repository at this point in the history
  • Loading branch information
bouteillerAlan committed Mar 13, 2024
1 parent aa7c764 commit a4af2c7
Show file tree
Hide file tree
Showing 19 changed files with 30 additions and 7 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
### v6.0.0
- Now a list of all the update is available on click (on systray and on plasmoid)
- You can choose if the click refresh the list or open the list
- You can personallyse the color of the list item
- Each package on the list can be updated one by one if needed
- The color of the icon should be correct on most of the theme now
- refresh action is available on the menu

### v5.1.0
- Thanks to Luis Bocanegra for finishing up the last warning on the plasma 6 upgrade
- The settings are divided by its theme now
Expand Down
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Arch update counter - plasma widget

![screenshot of the aplet with all the alt](git-assets/img/v4.2.0/all-alt.png)
![screenshot of the aplet with all the alt](git-assets/img/allalt.png)

1 - dot w/ custom color | 2 - dot with theme color | 3 - label | 4 - label with separator | 5 - in the system tray
1 - custom icon color | 2 - custom dot color | 3 - default dot | 4 - label with separator | 5 - label without separator | 6 - in the system tray | 7 - package list

## Description

Expand All @@ -16,7 +16,11 @@ Custom setting for the update command and for the count command !

You can choose between a dot or a label if an update is available.

Possibility to change the visual of the dot or the visual of the label.
Possibility to change the visual of the dot, the visual of the label and the visual of the icon.

A popup list all the available update.

And a lot of settings is provided for customizing all that !

## Installation

Expand Down Expand Up @@ -53,7 +57,7 @@ You need to have the following packages installed on your system:

Go to the 'System Tray Settings' menu and activate it :)

![screenshot of how to add in the systray](git-assets/img/v4.2.0/add-systray.png)
![screenshot of how to add in the systray](git-assets/img/add-systray.png)

## Configuration

Expand All @@ -67,14 +71,19 @@ Go to the 'System Tray Settings' menu and activate it :)
| Do not close the terminal at the end | if true add the `--noclose` flag into the `konsole` command | Prevent the console to close at the end of the update command |
| Count ARCH command | The command you want to execute for counting the packages for CORE and EXTRA (default: `checkupdates [pipe] wc -l`) | The `updater` exec this command |
| Count AUR command | The command you want to execute for counting the packages for the other db (default: `yay -Qua [pipe] wc -l`) | The `updater` exec this command |
| Update command | The command you want to execute when the `update` action is called | Pass the command to `konsole -e` |
| Update all command | The command for updating all the package at once | Pass the command to `konsole -e` |
| Update one command | The command for updating one package via the popup | Pass the command to `konsole -e` and add the package name at the end |
| Display | | |
| Show a dot in place of the label | Replace the label with a colored dot | If the total count is > than 0 the dot is visible, otherwise nothing is shown (no label, no dot) |
| Custom dot color | If you want to customize the color of the dot | If not checked the dot get the color from your theme via `PlasmaCore.Theme.textColor` |
| Separate result | If you want to have the total for *arch* and the total for the other db in the label | Set the label text to `' ' + totalArch + separator + totalAur + ' '` |
| Separator | The text you want to have for, space available | Inject the text you put into the label |
| Popup | | |
| Custom X color | You can tick the box if you want a custom color on the X element | Change the color on the popup element and on the preview in the same page |
| Separator text | Custom text for the version separator | Use the text provided to separate versions in the text |
| Mouse action | | |
| Click configuration | Choose the type of action you want to do for each click on the mouse | Left click to check, middle click to update OR Middle click to check, left click to update |
| Main action behavior | If you want to refresh the list or open the popup when you click | Main click depend on the choice made in the Click configuration settings |

### Regarding the customization of the commands

Expand All @@ -84,10 +93,16 @@ In no case I'm responsible of anything if your system break due to your command.

The program launch the update command with `konsole -e`. So you can test your command or script with `konsole -e "my_command"`.

For the update the default command is: `konsole -e (--noclose) 'yay'` where `noclose` is optional.
When you update all the packages the default command is: `konsole -e (--noclose) 'yay'` where `noclose` is optional.

When you update one package the default command is: `konsole -e (--noclose) 'yay -Sy' packageName` where `noclose` is optional and `packageName` is injected from the list.

## FAQ

### Why all these options for a similar command

I like to have the opportunity to really configure everything, and to do so simply.

### Why `yay` and `pacman-contrib`

`pacman-contrib` provide `checkupdates` for counting the update for the `core` and `extra` repository AND it sync all the db automatically without the need of sudo.
Expand Down Expand Up @@ -120,7 +135,7 @@ See the following file :

## Roadmap

- nothing yet, I take feature request on the go :)
- Nothing yet, I take feature request on the go :)

## Want to participate? Have a bug or a request feature?

Expand Down
File renamed without changes
File renamed without changes
Binary file added git-assets/img/allalt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added git-assets/img/optionpling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed git-assets/img/options-menu.png
Binary file not shown.
File renamed without changes
Binary file added git-assets/img/popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified git-assets/img/set1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified git-assets/img/set2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified git-assets/img/set3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added git-assets/img/set4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed git-assets/img/sync.png
Binary file not shown.
Binary file removed git-assets/img/systray-avalaible.png
Binary file not shown.
Binary file removed git-assets/img/systray-hide.png
Binary file not shown.
Binary file added git-assets/img/tooltip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed git-assets/img/up.png
Binary file not shown.
Binary file removed git-assets/img/v4.2.0/tooltips.png
Binary file not shown.

0 comments on commit a4af2c7

Please sign in to comment.