Skip to content

Commit 678a7f1

Browse files
committed
Add installation guide and release notes for TimeMachine v2.0.0
- Introduced comprehensive `INSTALL_GUIDE.md` detailing installation methods, system requirements, security checks, and troubleshooting tips. - Added `RELEASE_NOTES_V2.0.0.md` summarizing major updates, new features, critical bug fixes, UI/UX improvements, and technical enhancements for the v2.0.0 release. - Updated `build.gradle.kts` to reflect new versioning for the app (version 2.0.0). - Enhanced documentation to support user onboarding and provide clarity on new functionalities.
1 parent 2aa182c commit 678a7f1

3 files changed

Lines changed: 504 additions & 5 deletions

File tree

INSTALL_GUIDE.md

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,281 @@
1+
# TimeMachine v2.0.0 - Installation Guide
2+
3+
## 📱 Quick Installation
4+
5+
### Method 1: Direct Installation (Recommended)
6+
7+
1. **Transfer APK to Device**
8+
- Connect your Android device to computer via USB
9+
- Copy `TimeMachineV2.0.0.apk` to your device's Downloads folder
10+
- Or use ADB: `adb install TimeMachineV2.0.0.apk`
11+
12+
2. **Enable Unknown Sources**
13+
- Go to **Settings****Security****Unknown Sources**
14+
- Or **Settings****Apps****Special Access****Install Unknown Apps**
15+
- Enable for your file manager or browser
16+
17+
3. **Install**
18+
- Open your file manager
19+
- Navigate to Downloads
20+
- Tap on `TimeMachineV2.0.0.apk`
21+
- Tap **Install**
22+
- Wait for installation to complete
23+
- Tap **Open** to launch
24+
25+
### Method 2: ADB Installation (For Developers)
26+
27+
```bash
28+
# Connect device via USB with USB debugging enabled
29+
adb devices
30+
31+
# Install the APK
32+
adb install -r TimeMachineV2.0.0.apk
33+
34+
# Launch the app
35+
adb shell am start -n me.aliahad.timemanager/.MainActivity
36+
```
37+
38+
---
39+
40+
## ✅ System Requirements
41+
42+
- **Android Version**: 12 (API 31) or higher
43+
- **Storage**: At least 50 MB free space
44+
- **RAM**: 2 GB or more recommended
45+
- **Screen**: Any screen size supported
46+
47+
---
48+
49+
## 🔐 Security
50+
51+
### APK Verification
52+
53+
Verify the APK integrity before installation:
54+
55+
```bash
56+
# Check MD5 hash
57+
md5 TimeMachineV2.0.0.apk
58+
# Should output: 624619775c92b2466774015748e20a82
59+
```
60+
61+
### Signing Information
62+
63+
- **Signed**: ✅ Yes (Release keystore)
64+
- **Keystore**: `release-keystore.jks`
65+
- **Key Alias**: `timemanager`
66+
67+
---
68+
69+
## 🚀 First Launch
70+
71+
### Initial Setup
72+
73+
1. **Launch the App**
74+
- Tap the TimeMachine icon on your home screen
75+
- The app will initialize the database
76+
77+
2. **Grant Permissions (If Needed)**
78+
- The app requires minimal permissions
79+
- Notification permission (optional, for habit reminders)
80+
81+
3. **Start Using**
82+
- **Home Screen**: Shows all available features
83+
- **Focus Tracker**: Create categories and start tracking
84+
- **Year Calculator**: Calculate dates
85+
- **BMI Calculator**: Track your health metrics
86+
- **Habit Tracker**: Build better habits
87+
88+
---
89+
90+
## 🎯 Feature Quick Start
91+
92+
### Focus Tracker
93+
1. Tap **Focus Tracker** on home screen
94+
2. Go to **Categories** tab
95+
3. Tap **+ Add Category**
96+
4. Set name, icon, color, and daily goal
97+
5. Go back to **Track** tab
98+
6. Select your category
99+
7. Tap **Start Focus Session**
100+
8. Enter immersive fullscreen mode
101+
9. Double-tap to show/hide controls
102+
10. Press **STOP** when done (minimum 30s to save)
103+
104+
### Year Calculator
105+
1. Tap **Year Calculator** on home screen
106+
2. Select **Birthdate** or **From Date**
107+
3. Enter number of years
108+
4. View results instantly
109+
5. Tap **Save Calculation** to keep history
110+
111+
### BMI Calculator
112+
1. Tap **BMI Calculator** on home screen
113+
2. Enter your details:
114+
- Age
115+
- Height (ft/cm)
116+
- Weight (kg/lb)
117+
- Gender
118+
- Classification system (WHO/DGE)
119+
3. Tap **Calculate BMI**
120+
4. View results with graph and recommendations
121+
5. Tap **Save** to keep history
122+
123+
### Habit Tracker
124+
1. Tap **Habit Tracker** on home screen
125+
2. Tap **+** to add new habit
126+
3. Set name, icon, color
127+
4. Choose reminder time (optional)
128+
5. Tap habit card to mark as complete
129+
6. View streaks and statistics
130+
131+
---
132+
133+
## 🐛 Troubleshooting
134+
135+
### App Won't Install
136+
137+
**Error: "App not installed"**
138+
- Solution: Uninstall old version first
139+
- Go to Settings → Apps → TimeMachine → Uninstall
140+
- Then install the new APK
141+
142+
**Error: "Package conflicts with existing package"**
143+
- Solution: Clear app data before uninstalling
144+
- Or use: `adb uninstall me.aliahad.timemanager`
145+
146+
### App Crashes on Launch
147+
148+
**Black screen or immediate crash**
149+
- Solution 1: Clear app cache and data
150+
- Solution 2: Restart your device
151+
- Solution 3: Reinstall the app
152+
153+
**Database error**
154+
- Solution: The app auto-migrates from older versions
155+
- If issues persist, clear app data (loses local data)
156+
157+
### Features Not Working
158+
159+
**Sessions not saving**
160+
- Ensure you track for at least 30 seconds
161+
- Look for green "✓ Session will be saved" indicator
162+
- Check if category is selected
163+
164+
**Notifications not showing**
165+
- Go to Settings → Apps → TimeMachine → Notifications
166+
- Enable all notification channels
167+
- Check Do Not Disturb settings
168+
169+
**UI not updating**
170+
- Pull to refresh if available
171+
- Close and reopen the app
172+
- Data refreshes automatically when screens resume
173+
174+
---
175+
176+
## 📊 Data Management
177+
178+
### Backup Your Data
179+
180+
The app stores data locally in a SQLite database:
181+
- Location: `/data/data/me.aliahad.timemanager/databases/`
182+
- Database file: `timer_database.db`
183+
184+
To backup (requires root or ADB):
185+
```bash
186+
# Backup database
187+
adb pull /data/data/me.aliahad.timemanager/databases/timer_database.db ./backup.db
188+
189+
# Restore database
190+
adb push ./backup.db /data/data/me.aliahad.timemanager/databases/timer_database.db
191+
```
192+
193+
### Clear App Data
194+
195+
If you want to start fresh:
196+
1. Settings → Apps → TimeMachine
197+
2. Storage → Clear Data
198+
3. This will reset everything
199+
200+
---
201+
202+
## 🔄 Updating from Previous Versions
203+
204+
### From v1.x.x to v2.0.0
205+
206+
**Automatic Migration**:
207+
- Database automatically migrates to version 6
208+
- Old timer data is preserved (if any)
209+
- Habits and existing data remain intact
210+
211+
**Manual Steps**:
212+
1. Install `TimeMachineV2.0.0.apk` over existing version
213+
2. Or uninstall old version first (loses data)
214+
3. Launch app
215+
4. Migration happens automatically on first launch
216+
217+
**What's Changed**:
218+
- Focus Timer replaced with Focus Tracker
219+
- New category-based system
220+
- Old timer sessions (if any) are preserved
221+
222+
---
223+
224+
## 💡 Tips & Tricks
225+
226+
### Focus Tracker
227+
- Set realistic daily goals (e.g., 60-120 minutes)
228+
- Use categories for different activities (Work, Study, Exercise)
229+
- Double-tap in fullscreen to quickly check progress
230+
- Sessions under 30s won't save (prevents accidental taps)
231+
232+
### Year Calculator
233+
- Useful for age calculations
234+
- Perfect for anniversaries and milestones
235+
- Save important date calculations
236+
237+
### BMI Calculator
238+
- Track weight changes over time
239+
- Compare WHO vs DGE classifications
240+
- Use health tips for guidance
241+
242+
### Habit Tracker
243+
- Start with 1-3 habits (don't overwhelm yourself)
244+
- Enable reminders for consistency
245+
- Celebrate streaks!
246+
247+
---
248+
249+
## 🆘 Support
250+
251+
### Getting Help
252+
253+
1. **Check Release Notes**: Read `RELEASE_NOTES_V2.0.0.md`
254+
2. **Check Logs**: Use `adb logcat | grep TimeMachine`
255+
3. **Report Issues**: Contact developer with logs
256+
257+
### Known Issues
258+
259+
- **Deprecation warnings in build**: Cosmetic only, no impact on functionality
260+
- **Leap year dates**: Handled gracefully, no crashes
261+
- **Timezone**: All dates use device timezone
262+
263+
---
264+
265+
## 📝 Version Information
266+
267+
- **Version Name**: 2.0.0
268+
- **Version Code**: 5
269+
- **Package Name**: me.aliahad.timemanager
270+
- **Min SDK**: 31 (Android 12)
271+
- **Target SDK**: 36 (Android 16)
272+
- **Release Date**: October 20, 2025
273+
274+
---
275+
276+
## 🎉 Enjoy TimeMachine v2.0.0!
277+
278+
Thank you for using TimeMachine. We hope this update brings you better productivity and health tracking!
279+
280+
**Happy Time Managing!** ⏰✨
281+

0 commit comments

Comments
 (0)