From 70d0fb7d5436306a678edb9fa0e9fb47bf7d1fd4 Mon Sep 17 00:00:00 2001 From: Jacob Moura Date: Sat, 20 Jan 2024 01:22:38 -0300 Subject: [PATCH] update docs --- CONTRIBUTING.md | 7 ++++++- README.md | 5 +++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6f3d73..5b5998c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,11 +74,16 @@ Next, at the root of your locally cloned repository run the `use` command to swi puro use yuno ``` -And finally get all project dependencies: +Get all project dependencies: ```bash flutter pub get ``` +And finally, run the project: +```bash +flutter run --flavor dev --dart-define-from-file=.env +``` + ### Performing changes - Create a new local branch from `main` (e.g. `git checkout -b my-new-feature`) - Make your changes. diff --git a/README.md b/README.md index 8be3a9d..73a296d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,11 @@ YuNO is a minimalist, open-source retro gaming frontend designed to deliver a no - **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. +## Inspiration + +YuNO took inspiration from Steamdeck and Beacon. +We also used IGDB images for the games and a good amount of Daijishou emulator execution patterns. + ## Showcase 🎥