Skip to content

Commit

Permalink
Adjust Cargo instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Dec 11, 2024
1 parent faf35e8 commit 456624d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Madamiru is a cross-platform media player written in [Rust](https://www.rust-lan
that can automatically shuffle multiple videos, images, and songs at once in a grid layout.

## Features
* Customizable layout with multiple groups of dynamic media
* Video formats: AVI, M4V, MKV, MOV, MP4, WebM
* Image formats: BMP, GIF, ICO, JPEG, PNG, TIFF, SVG, WebP
* Audio formats: FLAC, M4A, MP3, WAV
Expand Down
1 change: 1 addition & 0 deletions assets/linux/com.mtkennerly.madamiru.metainfo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<p>Madamiru is a cross-platform media player written in Rust that can automatically play and shuffle multiple videos, images, and songs at once in a grid layout.</p>
<p>Features:</p>
<ul>
<li>Customizable layout with multiple groups of dynamic media</li>
<li>Video formats: AVI, M4V, MKV, MOV, MP4, WebM</li>
<li>Image formats: BMP, GIF, ICO, JPEG, PNG, TIFF, SVG, WebP</li>
<li>Audio formats: FLAC, M4A, MP3, WAV</li>
Expand Down
7 changes: 4 additions & 3 deletions docs/help/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@ You can install Madamiru one of these ways:

* To install or update: `cargo install --locked madamiru`

However, note that some features are not yet available in this version.
However, note that some features are not fully functional in this version.
The prebuilt release uses a pre-release version of some dependencies,
which is not possible when installing via Cargo.
which enables some additional functionality,
but this is not possible when installing via Cargo.

On Linux, this requires the following system packages, or their equivalents
for your distribution:

* Ubuntu: `sudo apt-get install -y gcc cmake libx11-dev libxcb-composite0-dev libfreetype6-dev libexpat1-dev libfontconfig1-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-libav`
* Ubuntu: `sudo apt-get install -y gcc cmake libx11-dev libxcb-composite0-dev libfreetype6-dev libexpat1-dev libfontconfig1-dev libgtk-3-dev libasound2-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-libav`

## Notes
If you are on Windows:
Expand Down

0 comments on commit 456624d

Please sign in to comment.