Skip to content

Commit 1199bc0

Browse files
authored
Merge pull request #15 from leesunghyun/codex/release-readme-polish
Polish README for first-time contributors
2 parents 08e3504 + 531f154 commit 1199bc0

1 file changed

Lines changed: 62 additions & 5 deletions

File tree

README.md

Lines changed: 62 additions & 5 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:
@@ -45,14 +54,54 @@ The modern version provides:
4554
## Quick start
4655

4756
1. Clone the repository
48-
2. Work in sequence with the migration PRs in this repository
57+
```bash
58+
git clone https://github.com/leesunghyun/Android-AAC-ViewModel-Practice.git
59+
cd Android-AAC-ViewModel-Practice
60+
```
61+
62+
2. Run tests
63+
64+
macOS / Linux:
65+
```bash
66+
./gradlew test
67+
./gradlew assembleDebug
68+
```
69+
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
79+
80+
The first alpha flow is: `List → Detail/Edit → Save → List` with shared state update.
81+
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`
85+
86+
## Release status
87+
88+
- First OSS alpha release: [v0.1.0-oss-alpha.1](https://github.com/leesunghyun/Android-AAC-ViewModel-Practice/releases/tag/v0.1.0-oss-alpha.1)
89+
- APK is provided as a sample debug artifact for manual smoke testing (not production release).
90+
91+
For full release details and run verification commands, see:
92+
- [Release Notes](docs/release-notes-v0.1.0-oss-alpha.1.md)
93+
- [Release Guide](docs/release-guide-v0.1.0-oss-alpha.1.md)
4994

5095
## Project structure
5196

52-
- `README.md`: project purpose and progress
53-
- `docs/`: migration notes and legacy baseline records
54-
- `legacy-app/`: archived legacy baseline code
55-
- `.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.
56105

57106
## Migration docs
58107

@@ -82,6 +131,14 @@ The modern version provides:
82131
- [x] Publish migration document bundle
83132
- [x] Add release notes and changelog section for v0.1.0-oss-alpha.1
84133

134+
## Next milestones (planned, v0.2)
135+
136+
- [ ] Add UI tests for article edit/delete interactions
137+
- [ ] Add `collectAsStateWithLifecycle` in Compose state collection
138+
- [ ] Replace demo placeholder with real screen recording (`docs/images/demo.gif`)
139+
- [ ] Improve Article detail validation UX
140+
- [ ] Prepare v0.2.0 roadmap and release notes
141+
85142
## Contributing
86143

87144
Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) and add small, focused changes.

0 commit comments

Comments
 (0)