Skip to content

Commit 49aae1a

Browse files
committed
Merge branch '1.0.24' of https://github.com/arn-c0de/InteractiveChecklists into 1.0.24
2 parents 1110017 + 5da6965 commit 49aae1a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@
5151
# InteractiveChecklists
5252

5353
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+
5457

5558
> **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.
5659
@@ -73,6 +76,7 @@ InteractiveChecklists is an Android application for viewing and interacting with
7376
- [License](#license)
7477

7578

79+
7680
## Features
7781

7882
- **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
99103

100104
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.
101105

106+
## Roadmap
107+
108+
Planned features and long-term improvements are tracked in the [Roadmap](docs/EN/planning/roadmap.md) document.
109+
110+
102111

103112
## Quick Start – Windows (Recommended & Easiest)
104113

@@ -414,7 +423,7 @@ See [docs/EN/features/DATAPAD_FEATURE.md](docs/EN/features/DATAPAD_FEATURE.md) f
414423
> 📝 **NOTE**
415424
> 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.
416425
417-
## Installation
426+
## Installation for Developer
418427

419428
Step-by-step instructions to get the project running locally.
420429

@@ -457,15 +466,6 @@ cd InteractiveChecklists
457466
- From the command line: `./gradlew assembleDebug` builds an APK; use `./gradlew installDebug` to install on a connected device.
458467

459468

460-
## Key Components
461-
462-
- `MainActivity.kt`: App entry point and navigation orchestration.
463-
- `data/files/InternalFileManager.kt`: Unified file management.
464-
- `ui/files/InternalFilesScreen.kt`: File browser and tagging UI.
465-
- `ui/checklist/MarkdownViewer.kt`: Interactive markdown checklist viewer.
466-
- `ui/checklist/PdfViewer.kt`: PDF viewer and annotation tools.
467-
- `data/quicknotes/QuickNoteManager.kt`: QuickNotes data layer.
468-
469469

470470
## Contributing
471471

@@ -479,11 +479,6 @@ Quick contribution ideas:
479479
For larger or breaking changes, please open an issue first to discuss design and scope.
480480

481481

482-
## Roadmap
483-
484-
Planned features and long-term improvements are tracked in the [Roadmap](docs/EN/planning/roadmap.md) document.
485-
486-
487482
## Support & Contact
488483

489484
If you encounter issues or have questions:
@@ -492,6 +487,11 @@ If you encounter issues or have questions:
492487
- For security-sensitive issues, please follow the instructions in [SECURITY.md](SECURITY.md).
493488
- For contribution coordination and discussions, see [COLLABORATORS.md](COLLABORATORS.md).
494489

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.
494+
495495

496496
## FAQ
497497

0 commit comments

Comments
 (0)