Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sakithb committed Jan 3, 2024
1 parent ba4040e commit fa845bc
Show file tree
Hide file tree
Showing 15 changed files with 26 additions and 37 deletions.
63 changes: 26 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,35 @@ Show controls and information of the currently playing media in the panel.

## Features

- Customize how the extension looks
- Disable elements you don't want
- Invoke different actions in many ways through mouse actions
- Basic media controls (play/pause/next/prev)
- Other media controls (loop/shuffle)
- And more...

---

## Notes

- Supports GNOME 3.36 and 3.38 (unmaintained), 40, 41, 42, 43, 44 and 45.
- GNOME 44 and below will not receive updates after v29/v28;
- Customize the extension the way you want it
- Basic media controls (play/pause/next/previous/loop/shuffle/seek)
- Mouse actions lets you run different actions via left/middle/right/scroll.
- Popup with album art and a slider to control the playback
- Scrolling animations
- Blacklist players

---

## Reporting issues

- Please attach a screenshot when you report something about visuals
- Please include version of the extension, gnome version and linux distribution
- Please attach a screenshot when you report something about visuals
- Please include version of the extension, gnome version and linux distribution

---

## How to install

#### Install from extensions.gnome.org (Recommended)

[<img src="assets/images/get-ego.png" height="100">](https://extensions.gnome.org/extension/4470/media-controls/)

#### Arch Linux (AUR)

`yay -S gnome-shell-extension-media-controls` _Stable release_

`yay -S gnome-shell-extension-media-controls-git` _Build of the main branch_
[<img src="assets/images/ego.png" height="100">](https://extensions.gnome.org/extension/4470/media-controls/)

#### Other distributions

Install from source

- Download "extension.zip" file from the releases tab
- Open a terminal in the path of extension.zip
- Install and enable the extension by executing `gnome-extensions install extension.zip --force` in the terminal
- Download archive file from the releases tab
- Open a terminal in the directory containing the downloaded file
- Install and enable the extension by executing `gnome-extensions install extension.zip --force` in the terminal

---

Expand All @@ -55,32 +42,34 @@ Pull requests are welcome.

To update the translation files run `./debug.sh -t` in the extensions directory after your code changes are finished. This will update the files in po folder. Then poedit (https://poedit.net/download) can be used to translate the strings. poedit can also be used to create new localization files.

## Screenshots
<a href="https://github.com/sakithb/media-controls/graphs/contributors">
<img src="https://contrib.rocks/image?repo=sakithb/media-controls" />
</a>

#### Track information menu
Made with [contrib.rocks](https://contrib.rocks).

![Screenshot](assets/images/track_info_menu.png)
## Screenshots

#### Sources menu
#### Popup menu

![Screenshot](assets/images/sources_menu.png)
![Screenshot](assets/images/popup.png)

#### General settings

![Screenshot](assets/images/settings_page_1.png)
![Screenshot](assets/images/prefs_general.png)

#### Visibility settings
#### Panel settings

![Screenshot](assets/images/settings_page_2.png)
![Screenshot](assets/images/prefs_panel.png)

#### Appearance settings
#### Position settings

![Screenshot](assets/images/settings_page_3.png)
![Screenshot](assets/images/prefs_positions.png)

#### Shortcut settings

![Screenshot](assets/images/settings_page_4.png)
![Screenshot](assets/images/prefs_shortcuts.png)

#### Other settings

![Screenshot](assets/images/settings_page_5.png)
![Screenshot](assets/images/prefs_other.png)
File renamed without changes
Binary file added assets/images/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 added assets/images/prefs_general.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 assets/images/prefs_other.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 assets/images/prefs_panel.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 assets/images/prefs_positions.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 assets/images/prefs_shortcuts.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 assets/images/settings_page_1.png
Binary file not shown.
Binary file removed assets/images/settings_page_2.png
Binary file not shown.
Binary file removed assets/images/settings_page_3.png
Binary file not shown.
Binary file removed assets/images/settings_page_4.png
Binary file not shown.
Binary file removed assets/images/settings_page_5.png
Binary file not shown.
Binary file removed assets/images/sources_menu.png
Binary file not shown.
Binary file removed assets/images/track_info_menu.png
Binary file not shown.

0 comments on commit fa845bc

Please sign in to comment.