You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,9 @@
51
51
# InteractiveChecklists
52
52
53
53
InteractiveChecklists is an Android application for viewing and interacting with Markdown and PDF checklists. It is built with Jetpack Compose and follows an MVVM-style architecture.
54
+
It is designed to be extensible with an interactive aviation map featuring live DCS data integration, tactical markers, and dynamic route and pattern calculation.
55
+
Runway heading–based approach visualization and real-time map updates enable enhanced situational awareness during flight operations.
56
+
54
57
55
58
> **Development status:** This repository is a development version and not an official release. The app is functional but under active development and may contain experimental features.
56
59
@@ -73,6 +76,7 @@ InteractiveChecklists is an Android application for viewing and interacting with
73
76
-[License](#license)
74
77
75
78
79
+
76
80
## Features
77
81
78
82
-**Unified File System:** Manage files from bundled assets and internal storage in a single hierarchical view.
@@ -99,6 +103,11 @@ InteractiveChecklists is an Android application for viewing and interacting with
99
103
100
104
Here is the **integrated, cleaned-up, and consistent Markdown version**, with the **“Unblocking Files in DCS World”** section properly embedded in a logical place. Language is corrected and suitable for a README / manual.
101
105
106
+
## Roadmap
107
+
108
+
Planned features and long-term improvements are tracked in the [Roadmap](docs/EN/planning/roadmap.md) document.
109
+
110
+
102
111
103
112
## Quick Start – Windows (Recommended & Easiest)
104
113
@@ -414,7 +423,7 @@ See [docs/EN/features/DATAPAD_FEATURE.md](docs/EN/features/DATAPAD_FEATURE.md) f
414
423
> 📝 **NOTE**
415
424
> This is a test recording to evaluate recording performance, tablet capture workflow, resolution settings, and overall system stability during DCS gameplay. Mission content and pacing are deliberately simple and functional.
416
425
417
-
## Installation
426
+
## Installation for Developer
418
427
419
428
Step-by-step instructions to get the project running locally.
420
429
@@ -457,15 +466,6 @@ cd InteractiveChecklists
457
466
- From the command line: `./gradlew assembleDebug` builds an APK; use `./gradlew installDebug` to install on a connected device.
458
467
459
468
460
-
## Key Components
461
-
462
-
-`MainActivity.kt`: App entry point and navigation orchestration.
-`ui/checklist/PdfViewer.kt`: PDF viewer and annotation tools.
467
-
-`data/quicknotes/QuickNoteManager.kt`: QuickNotes data layer.
468
-
469
469
470
470
## Contributing
471
471
@@ -479,11 +479,6 @@ Quick contribution ideas:
479
479
For larger or breaking changes, please open an issue first to discuss design and scope.
480
480
481
481
482
-
## Roadmap
483
-
484
-
Planned features and long-term improvements are tracked in the [Roadmap](docs/EN/planning/roadmap.md) document.
485
-
486
-
487
482
## Support & Contact
488
483
489
484
If you encounter issues or have questions:
@@ -492,6 +487,11 @@ If you encounter issues or have questions:
492
487
- For security-sensitive issues, please follow the instructions in [SECURITY.md](SECURITY.md).
493
488
- For contribution coordination and discussions, see [COLLABORATORS.md](COLLABORATORS.md).
494
489
490
+
### Bug Reports
491
+
492
+
When reporting a bug, please include a **screenshot** if possible.
493
+
Use the screenshot to **mark or highlight the exact area** where the issue occurs, and briefly **describe what is shown and what is wrong** in that location.
0 commit comments