diff --git a/packages/trashy_road/README.md b/packages/trashy_road/README.md index 9a395983..67641b26 100644 --- a/packages/trashy_road/README.md +++ b/packages/trashy_road/README.md @@ -1,16 +1,35 @@ -# trashy_road +# Trashy Town -A new Flutter project. + -## Getting Started +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). -This project is a starting point for a Flutter application. +**All** assets were made in-house. -A few resources to get you started if this is your first Flutter project: +--- -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +[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. -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. + + +## 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. diff --git a/packages/trashy_road/docs/assets/logo.png b/packages/trashy_road/docs/assets/logo.png new file mode 100644 index 00000000..1b18ab00 Binary files /dev/null and b/packages/trashy_road/docs/assets/logo.png differ