Merge remote-tracking branch 'origin/main'

CONTRIBUTING.md

@@ -0,0 +1,121 @@
+# Contribution Guidelines
+
+**Note:** If these contribution guidelines are not followed your issue or PR might be closed, so
+please read these instructions carefully.
+
+## Contribution types
+
+### Bug Reports
+- If you find a bug, please first report it using [Github issues].
+    - First check if there is not already an issue for it; duplicated issues will be closed.
+
+### Bug Fix
+- If you'd like to submit a fix for a bug, please read the [How To](#how-to-contribute) for how to
+  send a Pull Request.
+- Indicate on the open issue that you are working on fixing the bug and the issue will be assigned
+  to you.
+- Write `Fixes #xxxx` in your PR text, where xxxx is the issue number (if there is one).
+- Include a test that isolates the bug and verifies that it was fixed.
+
+### New Features
+- If you'd like to add a feature to the library that doesn't already exist, feel free to describe
+  the feature in a new [GitHub issue].
+- If you'd like to implement the new feature, please wait for feedback from the project maintainers
+  before spending too much time writing the code. In some cases, enhancements may not align well
+  with the project objectives at the time.
+- Implement the code for the new feature and please read the [How To](#how-to-contribute).
+
+### Documentation & Miscellaneous
+- If you have suggestions for improvements to the documentation, tutorial or examples (or something
+  else), we would love to hear about it.
+- As always first file a [Github issue].
+- Implement the changes to the documentation, please read the [How To](#how-to-contribute).
+
+## How To Contribute
+
+### Requirements
+For a contribution to be accepted:
+
+- Documentation should always be updated or added.*
+- Examples should always be updated or added.*
+- Tests should always be updated or added.*
+- Format the Dart code accordingly with `flutter format`.
+- Your code should pass all tests `flutter run test`.
+- Start your PR title with a [conventional commit] type
+  (`feat:`, `fix:` etc).
+
+*When applicable.
+
+If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the issue
+or PR. You can still continue to add more commits to the branch you have sent the Pull Request from
+and it will be automatically reflected in the PR.
+
+## Open an issue and fork the repository
+- If it is a bigger change or a new feature, first of all
+  [file a bug or feature report][GitHub issues], so that we can discuss what direction to follow.
+- [Fork the project][fork guide] on GitHub.
+- Clone the forked repository to your local development machine
+  (e.g. `git clone git@github.com:<YOUR_GITHUB_USER>/yuno.git`).
+
+### Environment Setup
+Yuno uses [Puro] to manage the Flutter version.
+
+To install Puro, you can take a look at the documentation [here][Puro install].
+
+After installation, run the following command from your terminal changing `x.xx.x` for flutter version see in pubspec.yaml file:
+
+```bash
+puro create yuno x.xx.x
+```
+
+Next, at the root of your locally cloned repository run the `use` command to switch to the environment you created:
+
+```bash
+puro use yuno
+```
+
+And finally get all project dependencies:
+```bash
+flutter pub get
+```
+
+### Performing changes
+- Create a new local branch from `main` (e.g. `git checkout -b my-new-feature`)
+- Make your changes.
+- When committing your changes, make sure that each commit message is clear
+  (e.g. `git commit -m '[yuno_ui] Added LoadAnimation on buttons'`).
+- Push your new branch to your own fork into the same remote branch
+  (e.g. `git push origin my-username.my-new-feature`, replace `origin` if you use another remote.)
+
+### Open a pull request
+Go to the [pull request page of yuno][PRs] and in the top
+of the page it will ask you if you want to open a pull request from your newly created branch.
+
+The title of the pull request should start with a [conventional commit] type.
+
+Examples of such types:
+- `fix:` - patches a bug and is not a new feature.
+- `feat:` - introduces a new feature.
+- `docs:` - updates or adds documentation or examples.
+- `test:` - updates or adds tests.
+- `refactor:` - refactors code but doesn't introduce any changes or additions to the public API.
+
+If you introduce a **breaking change** the conventional commit type MUST end with an exclamation
+mark (e.g. `feat!: The intent to get titles and images don't works for linux`).
+
+Examples of PR titles:
+- feat!: New auto-dispose configuration.
+- feat: Added Page.setArguments.
+- docs: Add Contribution Guidelines.
+- test: Add Export bind test.
+- chore: Removed triple dependency.
+- refactor: Now the default theme is dark.
+
+[GitHub issue]: https://github.com/Flutterando/yuno/issues/new
+[GitHub issues]: https://github.com/Flutterando/yuno/issues/new
+[PRs]: https://github.com/Flutterando/yuno/pulls
+[fork guide]: https://guides.github.com/activities/forking/#fork
+[Puro]: https://puro.dev/
+[Puro install]: https://puro.dev/#installation
+[pubspec doc]: https://dart.dev/tools/pub/pubspec
+[conventional commit]: https://www.conventionalcommits.org

README.md

@@ -1,16 +1,46 @@
-# yuno
+<br />
+<div Align="Center">
+<img src="assets/logo-prod.png" width="100" alt="Logo yuno"/>
+</div>
 
-A new Flutter project.
 
-## Getting Started
+# Yuno
 
-This project is a starting point for a Flutter application.
+Yuno is a minimalist, open-source retro gaming frontend designed to deliver a nostalgic and efficient gaming experience. This project aims to create a simplified interface for accessing and playing your favorite retro games.
 
-A few resources to get you started if this is your first Flutter project:
+## Characteristics
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+- **Minimalist**: Clean and simple user interface, focused on gameplay.
+- **Compatibility**: Supports a wide variety of emulators and retro games.
+- **Open source**: Free to use, modify and distribute, see the [license](LICENSE). Contributions are welcome!
+- **Customizable**: Options to personalize the experience according to your preferences.
 
-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.
+## Showcase 🎥
+
+
+## Prerequisites ⚙️
+
+Before installing Yuno, make sure you have the following requirements:
+
+- Operating System: Android.
+- Compatible emulators and ROMs for the games you want to play.
+
+## Installation 🕹️
+See [Realeses](https://github.com/Flutterando/yuno/releases) 
+
+## Contribute 👩‍💻🧑‍💻
+I am happy that you are looking to improve bruno. Please check out the [contributing guide](CONTRIBUTING.md)
+
+Even if you are not able to make contributions via code, please don't hesitate to file bugs and feature requests that need to be implemented to solve your use case.
+
+### Authors
+
+<div align="center">
+    <a href="https://github.com/Flutterando/yuno/graphs/contributors">
+        <img src="https://contrib.rocks/image?repo=Flutterando/yuno" />
+    </a>
+</div>
+
+### License 📄
+
+[YuNO Software License Agreement](LICENSE)