docs: update README, Linux: replace with symlink, update Requirements (…

…#1190)

* docs: update README, Linux: replace with symlink, update Requirements

* docs: show linux requirements in getting_started.md (closes #1178)

Co-authored-by: Luan Nico <luanpotter27@gmail.com>

README.md

@@ -6,7 +6,7 @@ A Flutter plugin to play multiple simultaneously audio files, works for Android,
 
 <img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot1.png" width="250" /> <img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot2.png" width="250" /> <img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot3.png" width="250" />
 
-**Note**: all the docs have been update to reflect the content for the v1 release (currently `1.0.0-rc.4`). If you are looking for v0 specific information and guidance, please checkout [the version of this repo before the first v0 change](https://github.com/bluefireteam/audioplayers/tree/46816bf55859c9c88b204e3828cce6190ff87483).
+**Note**: all the docs have been update to reflect the content for the v1 release. If you are looking for v0 specific information and guidance, please checkout [the version of this repo before the first v0 change](https://github.com/bluefireteam/audioplayers/tree/46816bf55859c9c88b204e3828cce6190ff87483).
 
 If you are interest in migrating to v1, please check [our migration guide](migration_guide.md).
 
@@ -38,7 +38,7 @@ We tried to make audioplayers as simple to use as possible.
 
 Please follow our [Getting Started tutorial](getting_started.md) for all high-level information you need to know.
 
-Then, if you want to dig deeper, our code is very well documented with dartdocs, so check [our API reference](https://pub.dev/documentation/audioplayers/1.0.0-rc.1/) or the codebase itself on your IDE (or on GitHub).
+Then, if you want to dig deeper, our code is very well documented with dartdocs, so check [our API reference](https://pub.dev/documentation/audioplayers/latest/) or the codebase itself on your IDE (or on GitHub).
 
 If something is not clear on our docs, please send a PR to help us improve.
 

getting_started.md

@@ -4,6 +4,10 @@ This tutorial should help you get started with the audioplayers library, coverin
 
 In order to install this package, add the [latest version](pub.dev/packages/audioplayers) of `audioplayers` to your `pubspec.yaml` file. This packages uses [the Federated Plugin](https://docs.flutter.dev/development/packages-and-plugins/developing-packages) guidelines to support multiple platforms, so it should just work on all supported platforms your app is built for without any extra configuration. You should not need to add the `audioplayers_*` packages directly.
 
+## Build Requirements
+
+Audioplayers for Linux (`audioplayers_linux`) is the only platform implementation which relies on additional dependencies. You need to fulfill [these requirements](packages/audioplayers_linux/requirements.md).
+
 ## AudioPlayer
 
 An `AudioPlayer` instance can play a single audio at a time (think of it as a single boombox). To create it, simply call the constructor:
@@ -272,4 +276,4 @@ By default, each time you initialize a new instance of AudioPlayer, a unique pla
   final player = AudioPlayer(playerId: 'my_unique_playerId');
 ```
 
-Two players with the same id will point to the same media player on the native side.
+Two players with the same id will point to the same media player on the native side.

packages/audioplayers_linux/README.md

@@ -0,0 +1 @@
+../../README.md

packages/audioplayers_linux/requirements.md

@@ -1,5 +1,9 @@
 # Requirements for Linux
 
+## Debian
+
+### Dev Dependencies
+
 [Flutter](https://docs.flutter.dev/get-started/install/linux#additional-linux-requirements) dependencies:
 
 ```bash
@@ -12,10 +16,12 @@ sudo apt-get install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
 sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
 ```
 
-Optional GStreamer Bad Plugins (e.g. for `.m3u8`):
+### App Dependencies
+
+Optional GStreamer Plugins (e.g. for `.m3u8`):
 
 ```bash
-sudo apt-get install gstreamer1.0-plugins-bad
+sudo apt-get install gstreamer1.0-plugins-good gstreamer1.0-plugins-bad
 ```
 
 ## ArchLinux
@@ -26,4 +32,4 @@ For Arch, simply install gstreamer and its plugins via `pacman`:
 sudo pacman -S gstreamer gst-libav gst-plugins-base gst-plugins-good
 ```
 
-You can install additional plugins as needed following [the Wiki](https://wiki.archlinux.org/title/GStreamer).
+You can install additional plugins as needed following [the Wiki](https://wiki.archlinux.org/title/GStreamer).