Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alestiago committed Mar 12, 2024
1 parent f19b00f commit de2028f
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 33 deletions.
File renamed without changes
34 changes: 1 addition & 33 deletions packages/trashy_road/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,3 @@
# 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 and recycling public spaces. 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).

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).

0 comments on commit de2028f

Please sign in to comment.