Zyron

A simple desktop application written in Flutter to access and manage your favorite entertainment content.

Contents

• Features
• Installation
• Building from source
• Contributing
• Credits
• License

Features

• Simple and intuitive interface: Zyron is designed to be easy to use and navigate.
• Customizable: You can add your favorite content to the app and access it easily.
• Cross-platform: Zyron is built using Flutter, so it can run on Windows, macOS, and Linux.
• Open-source: Zyron is open-source and free to use.

Installation

To use Zyron, you can run the installer or build the application from source.

Building from source

To install build Zyron from source, you need to have Flutter installed on your system. You can follow the instructions on the official Flutter website to install it. Also, you need to have mpv installed.

1. Clone the repository:

git clone https://github.com/aymanfarsi/Zyron.git

2. Reinitialize the project directory:

mv Zyron zyron
cd zyron
flutter create .

3. Build the project:

flutter build <platform>

Replace with the platform you want to build for (windows, macos, or linux)

4. The binary will be located in the build/<platform>/ directory.

5. You can also run the application using the following command:

flutter run

Add the --release flag to run the application in release mode.

6. You can also run script for building and bundling the app:

• ./generate_files to generate the boilerplate code for the Flutter Rust bridge and Freezed classes.
• ./build_app to build the app for your current platform.
• ./distribute_app to build and distribute the app for all platforms.

Add sh before the script name if you are using Windows.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have any ideas, bug reports, or feature requests.

1. Fork the repository and clone it to your local machine.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push the changes.
5. Submit a pull request.

Credits

Zyron is built using the following technologies:

• Flutter
• Dart
• flutter_rust_bridge
• mpv

License

Zyron is licensed under the MIT License. See the LICENSE file for more information.