Skip to content

Commit fe34d40

Browse files
committed
Add development setup instructions to README.md
1 parent 18777f6 commit fe34d40

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,36 @@ Here are some screenshots of the app in action:
3131
* **On Android:** Get it from [GitHub Releases](https://github.com/TheHelloWorldWriter/hello_world_counters/releases).
3232
* **On any platform:** [Run the web app](https://helloworldcounters.thehelloworldwriter.com/) or install it directly from your browser on most modern operating systems, including Android, ChromeOS, iOS, Linux, macOS, and Windows.
3333

34+
## Development
35+
36+
These steps assume you have **Flutter ≥ 3.x** installed. See [flutter.dev/get-started](https://flutter.dev/get-started) for setup if needed.
37+
38+
1. **Clone the repo**
39+
```bash
40+
git clone https://github.com/TheHelloWorldWriter/hello_world_counters.git
41+
cd hello_world_counters
42+
```
43+
44+
2. **Switch to main branch**
45+
```bash
46+
git checkout main
47+
```
48+
49+
3. **Install dependencies**
50+
```bash
51+
flutter pub get
52+
```
53+
54+
4. **Run the app**
55+
- **Web / PWA**
56+
```bash
57+
flutter run -d chrome
58+
```
59+
- **Android (emulator / device)**
60+
```bash
61+
flutter run -d <device-id>
62+
```
63+
3464
## Contributing
3565

3666
Thank you for contributing! Hello World Counters is designed to be as simple and useless as possible, but you can still help with:

0 commit comments

Comments
 (0)