Skip to content

Commit 531f154

Browse files
committed
Refine README onboarding polish for alpha release and onboarding clarity
1 parent 652b2fa commit 531f154

2 files changed

Lines changed: 35 additions & 29 deletions

File tree

README.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ A beginner-friendly OSS migration lab that modernizes a 2017 Android AAC ViewMod
44

55
This repository is now in the **release readiness phase** of the OSS rebuild.
66

7+
## Requirements
8+
9+
- Android Studio
10+
- JDK 17
11+
- Android SDK
12+
- Git
13+
14+
If you use Android Studio, the bundled JBR is usually enough.
15+
716
## Current status
817

918
Completed in this phase:
@@ -49,22 +58,30 @@ The modern version provides:
4958
git clone https://github.com/leesunghyun/Android-AAC-ViewModel-Practice.git
5059
cd Android-AAC-ViewModel-Practice
5160
```
52-
2. Build tests (first-time setup complete on CI)
61+
62+
2. Run tests
63+
64+
macOS / Linux:
5365
```bash
5466
./gradlew test
55-
```
56-
3. Build and install the debug app
57-
```bash
5867
./gradlew assembleDebug
59-
./gradlew installDebug
6068
```
61-
4. Open the project in Android Studio and run `app`.
6269

63-
## Demo preview
70+
Windows:
71+
```bat
72+
gradlew.bat test
73+
gradlew.bat assembleDebug
74+
```
75+
76+
3. Open in Android Studio and run the `app` module.
77+
78+
## Demo
6479

6580
The first alpha flow is: `List → Detail/Edit → Save → List` with shared state update.
6681

67-
![v0.1.0 OSS alpha demo placeholder](docs/assets/v0.1.0-oss-alpha-demo-placeholder.svg)
82+
`v0.1.0-oss-alpha.1` currently uses a placeholder visual in this PR.
83+
84+
Planned path (v0.2): `docs/images/demo.gif`
6885

6986
## Release status
7087

@@ -77,10 +94,14 @@ For full release details and run verification commands, see:
7794

7895
## Project structure
7996

80-
- `README.md`: project purpose and progress
81-
- `docs/`: migration notes and legacy baseline records
82-
- `legacy-app/`: archived legacy baseline code
83-
- `.github/`: pull request and issue templates
97+
```text
98+
app/ Modern Kotlin + Compose sample app (built in this alpha)
99+
legacy-app/ Original 2017 Android AAC sample (archive only, reference)
100+
docs/ Migration documentation and release notes
101+
```
102+
103+
Only `app/` is built in the first alpha.
104+
`legacy-app/` is preserved for historical reference only.
84105

85106
## Migration docs
86107

@@ -110,11 +131,11 @@ For full release details and run verification commands, see:
110131
- [x] Publish migration document bundle
111132
- [x] Add release notes and changelog section for v0.1.0-oss-alpha.1
112133

113-
## Next milestones (draft)
134+
## Next milestones (planned, v0.2)
114135

115136
- [ ] Add UI tests for article edit/delete interactions
116137
- [ ] Add `collectAsStateWithLifecycle` in Compose state collection
117-
- [ ] Replace placeholder demo image with real screen recording
138+
- [ ] Replace demo placeholder with real screen recording (`docs/images/demo.gif`)
118139
- [ ] Improve Article detail validation UX
119140
- [ ] Prepare v0.2.0 roadmap and release notes
120141

docs/assets/v0.1.0-oss-alpha-demo-placeholder.svg

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)