From de2028f14237ba83d9dc98eb0d6fb032c33ed587 Mon Sep 17 00:00:00 2001 From: alestiago Date: Tue, 12 Mar 2024 18:47:12 +0000 Subject: [PATCH] docs: update README.md --- .../trashy_road/docs => docs}/assets/logo.png | Bin packages/trashy_road/README.md | 34 +----------------- 2 files changed, 1 insertion(+), 33 deletions(-) rename {packages/trashy_road/docs => docs}/assets/logo.png (100%) diff --git a/packages/trashy_road/docs/assets/logo.png b/docs/assets/logo.png similarity index 100% rename from packages/trashy_road/docs/assets/logo.png rename to docs/assets/logo.png diff --git a/packages/trashy_road/README.md b/packages/trashy_road/README.md index 67641b26..0dd99fa2 100644 --- a/packages/trashy_road/README.md +++ b/packages/trashy_road/README.md @@ -1,35 +1,3 @@ # Trashy Town - - -Developed for the [Global Gamers Challenge](https://globalgamers.devpost.com/) by [Alejandro Santiago](https://github.com/alestiago), [Ollie Pugh](https://github.com/OlliePugh) and [Samantha Helm](https://www.behance.net/samanthahelmdesign). - -**All** assets were made in-house. - ---- - -[Trashy Town](https://trashytown.com) is a sustainable, family-friendly game that promotes collectively cleaning and recycling public spaces. Have fun helping Gary collect all the trash of his Trashy Town and recyle it into the correct trash cans. - - - -## Playing - -To start cleaning Trashy Town we recommend playing on **Desktop** 🖥 at [trashytown.com](https://trashytown.com). - -💡 **Note**: [trashytown.com](https://trashytown.com) also works on **Mobile**. - -Alternatively, you can run your own local version by using the Flutter SDK 3.19.0: - -```sh -# 🕹️ Play your local version of Trashy Town (from packages/trashy_road): -flutter run -d chrome --release -``` - -💡 **Note**: You can also run Trashy Town locally on all the other available platforms (MacOS, Windows, Android, iOS, Linux and Web). - -If instead, you wish to contribute refer to the [CONTRIBUTING](CONTRIBUTING.md). - -### Controls - -- 🖥 Desktop: move around with WASD or arrow keys. -- 📱 Mobile: tap to move forward or swipe to move vertically or horizontally. +The Trashy Town application, to learn more about this proyect refer to [README](https://github.com/alestiago/trashy_town/blob/main/README.md).