Skip to content

Commit 385b7de

Browse files
markrcoteclaude
andcommitted
Add local development instructions to README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 14b1cfe commit 385b7de

1 file changed

Lines changed: 41 additions & 3 deletions

File tree

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,52 @@ An Android app for tracking [German Volume Training](https://www.t-nation.com/tr
1414

1515
- Android 7.0 (API 24) or higher
1616

17-
## Building
17+
## Local Development
1818

19-
Open the project in Android Studio and build normally, or from the command line:
19+
### Prerequisites
2020

21+
- [Android Studio](https://developer.android.com/studio) (recommended), or Android SDK with command-line tools
22+
- JDK 17 or higher
23+
24+
### Setup
25+
26+
1. Clone the repository:
27+
```bash
28+
git clone https://github.com/markrcote/gvtimer.git
29+
cd gvtimer
30+
```
31+
32+
2. Open in Android Studio (**File > Open**), or use the command line directly.
33+
34+
### Building
35+
36+
```bash
37+
./gradlew assembleDebug # debug build
38+
./gradlew assembleRelease # release build
39+
```
40+
41+
### Running on a device or emulator
42+
43+
**Android Studio:** Select a device (or create an emulator via **Device Manager**) and click **Run**.
44+
45+
**Command line — start an emulator:**
46+
```bash
47+
# List available AVDs
48+
emulator -list-avds
49+
50+
# Start one (replace <avd-name> with an AVD from the list above)
51+
emulator -avd <avd-name> &
52+
```
53+
54+
**Command line — install and run:**
2155
```bash
22-
./gradlew assembleRelease
56+
./gradlew installDebug # installs debug build on connected device/emulator
2357
```
2458

59+
### Making UI changes
60+
61+
All timer logic and UI lives in a single file: `app/src/main/assets/index.html`. You can edit this file directly in any text editor — no Android-specific tooling required. After editing, rebuild and reinstall to see changes.
62+
2563
## Architecture
2664

2765
The app is a thin Android wrapper (Kotlin + Jetpack Compose) around a self-contained HTML/CSS/JavaScript web app loaded from the local assets. The web app handles all timer logic and UI.

0 commit comments

Comments
 (0)