Merge branch 'main' into olliepugh/bird

README.md

@@ -1 +1,49 @@
-# trashy_road
+# Trashy Town
+
+<img src="docs/assets/logo.png" width="400px" />
+
+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 public spaces and recycling. Have fun helping Gary collect all the trash of his Trashy Town and recyle it into the correct trash cans.
+
+<!-- Thumbnail with a play icon on the middle that anchors to the video, goes here --->
+
+## 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).
+
+### Playing with Admin privileges
+
+If you wish to run the game in 🛡️ **Admin** role , you should access [trashytown.com/?admin=true](https://trashytown.com/?admin=true).
+
+Having admin privileges unlocks all the levels so you can freely play the game.
+
+### Game controls
+
+Once you're playing a level you can control Gary with:
+
+- 🖥 Desktop: move around with WASD or arrow keys.
+- 📱 Mobile: tap to move forward or swipe to move vertically or horizontally.
+
+## Contributing
+
+For contributing information refer to the [CONTRIBUTING.md](packages/trashy_road/CONTRIBUTING.md) file.
+
+---
+
+🕊️ Special thanks to Darío Santiago, David Rodríguez, Adrián Santiago, Sam Inchley and Marta Quintana.

packages/trashy_road/README.md

@@ -1,16 +1,3 @@
-# trashy_road
+# Trashy Town
 
-A new Flutter project.
-
-## Getting Started
-
-This project is a starting point for a Flutter application.
-
-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)
-
-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.
+The Trashy Town application, to learn more about this proyect refer to [README](https://github.com/alestiago/trashy_town/blob/main/README.md).