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

docs: update README #326

Merged
merged 6 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions packages/trashy_road/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,35 @@
# trashy_road
# Trashy Town

A new Flutter project.
<img src="docs/assets/logo.png" width="400px" />

## 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.
<!-- 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.
Binary file added packages/trashy_road/docs/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading