diff --git a/gui/README.md b/gui/README.md index 75ccbda..1288106 100644 --- a/gui/README.md +++ b/gui/README.md @@ -1,16 +1,39 @@ -# reboot_launcher -Launcher for project reboot +# Reboot Launcher + +Welcome to the **Reboot Launcher**! +This is a GUI application developed as part of the **Reboot Project**. ## Getting Started -This project is a starting point for a Flutter application. +### Running the Project +To launch the project in development mode, simply run: +``` +flutter run +``` -A few resources to get you started if this is your first Flutter project: +### Building the Project +To create a production-ready build, use: +``` +flutter build +``` -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +### Packaging the Project +To package the application for distribution, run: +``` +package.bat +``` -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## Requirements +- [Flutter SDK](https://flutter.dev/docs/get-started/install) +- Supported operating systems: Windows + +## Other platforms + +Native support for these platforms is not currently planned, but Linux support is a priority for the 10.0 release cycle + +- [Linux Tutorial using Proton](https://www.reddit.com/r/linux_gaming/comments/1fwa4l8/guide_running_a_fortnite_private_server_to_play/) +- No tutorials are available for MacOS(got lost when the Reboot discord was banned), but it's possible to run Reboot using a compatibility layer + +## Contributing +Contributions are welcome! Feel free to open an issue or submit a pull request. \ No newline at end of file