Skip to content

Commit

Permalink
Enhanced README with Detailed Project Overview and Refined Installati…
Browse files Browse the repository at this point in the history
…on Guide

## Changelog for ATAK-Maps

### Latest Update

#### Overview
- **Enhanced Description**: Introduced a 'Detailed Overview' section for comprehensive information about ATAK-Maps.
- **Clarified Affiliation**: Added a statement clarifying non-affiliation with TAK.GOV.

#### Details of ATAK-Maps
- **Expanded Explanation**: Detailed descriptions added under 'What are ATAK-Maps?' and 'MOBAC Format' sections.
- **Usage and Functionality Enhancements**: Information about dynamic map access, offline caching, and customization features included.

#### Installation Guide
- **Revised Steps**: Installation guide streamlined for clarity and ease of understanding.
- **Updated Instructions**: Modified steps for downloading, locating, extracting, transferring, and verifying ATAK-Maps.

#### FAQ Section
- **Refined Questions**: Updated FAQ to focus on caching capabilities and map updates, removing redundant questions.

#### Open Street Maps Compatibility
- **Clarification**: Updated wording to indicate potential restrictions by Open Street Maps and ongoing solution exploration.

#### Repository Contributions and Support
- **Revised Sections**: 'Contributing' and 'Support' sections updated to invite contributions and provide support information effectively.

#### License
- **License Update**: Confirmed that ATAK-Maps is distributed under the MIT License.

### Notes:
- This changelog reflects significant enhancements to the ATAK-Maps README, aimed at improving clarity, detail, and user guidance.
- Users are encouraged to review the updated README for a comprehensive understanding of the project's capabilities and usage.
  • Loading branch information
joshuafuller authored Jan 2, 2024
1 parent a05c1f4 commit ee1ec14
Showing 1 changed file with 41 additions and 22 deletions.
63 changes: 41 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,53 @@

![ATAK-Maps Logo](https://github.com/joshuafuller/ATAK-Maps/blob/master/images/ATAK-Maps-Logo-White.png?raw=true)


![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/joshuafuller/ATAK-Maps) ![GitHub Release Date](https://img.shields.io/github/release-date/joshuafuller/ATAK-Maps?style=flat) ![GitHub All Releases](https://img.shields.io/github/downloads/joshuafuller/ATAK-Maps/total?style=flat) [![Discord](https://img.shields.io/discord/698067185515495436?style=flat)](https://discord.gg/dQUYADMW87)

## 🌍 About ATAK-Maps
ATAK-Maps offers a selection of MOBAC formatted XML files pointing to various online map sources. These maps enhance situational awareness and operational capabilities in ATAK (Android Tactical Assault Kit), a geospatial mapping tool used by military, law enforcement, and emergency services. For more information on ATAK, visit [TAK.gov](https://www.tak.gov).
## Detailed Overview of ATAK-Maps

ATAK-Maps is a comprehensive collection of XML files, formatted in the Mobile Atlas Creator (MOBAC) format. This format is used in [Android Tactical Assault Kit (ATAK)](https://tak.gov), an advanced geospatial mapping tool employed in various sectors including military, law enforcement, and emergency services. This repo and it's contents are not affiliated with TAK.GOV in any way.

### What are ATAK-Maps?

These XML files in ATAK-Maps act as pointers or references to a multitude of online map sources. By using these files, ATAK can seamlessly access and display current and relevant map imagery from these sources. This capability is vital for operations requiring up-to-date geospatial information.

### MOBAC Format

The MOBAC format is integral to the functionality of ATAK-Maps. It enables the definition of how ATAK accesses these online map sources. For more detailed information on the MOBAC format, visit [Mobile Atlas Creator](https://mobac.sourceforge.io/).

### Usage and Functionality

- **Dynamic Map Access**: ATAK-Maps facilitates the dynamic access of various map sources, ensuring that users have the most current imagery available for their operational needs.
- **Offline Caching**: One of the key features of ATAK is its ability to cache these maps. With ATAK-Maps, users can download and store map areas for offline use, which is crucial in environments with limited or no internet access.
- **Customization and Selection**: Users can also select specific areas and set the desired image quality for downloads, allowing for tailored map coverage based on operational requirements.

## Installation Guide

To integrate ATAK-Maps into your ATAK application, follow these steps:

1. **Download**: Get `ATAK-Maps.zip` from the [Releases page](https://github.com/joshuafuller/ATAK-Maps/releases).
2. **Locate**: Navigate to 'Downloads' in your file manager.
3. **Extract**: Open `ATAK-Maps.zip` and extract its contents.
4. **Transfer**: Move the files to the `ATAK/imagery` directory.
5. **Verify**: In ATAK, ensure the new maps appear in the map list.

## Frequently Asked Questions (FAQ)

- **Can I cache these maps for offline use?** Yes, ATAK supports automatic and manual caching of maps.
- **Will more maps be added?** We continuously update our map collection. Share your suggestions [here](https://github.com/joshuafuller/ATAK-Maps/issues).

## Open Street Maps Compatibility

## 📥 Installation Guide
Follow these steps to install maps on your mobile device:
Please note that Open Street Maps may restrict ATAK client access. These maps are included for reference, and we're exploring solutions.

1. **Download**: Go to the [ATAK-Maps GitHub Release page](https://github.com/joshuafuller/ATAK-Maps/releases) and download `ATAK-Maps.zip`.
2. **Locate**: Open your file manager and navigate to 'Downloads'.
3. **Extract**: Tap on `ATAK-Maps.zip` and extract its contents.
4. **Transfer**: Move the extracted files to `ATAK/imagery`.
5. **Verify**: Open ATAK and check the new maps in the map list.
## Contributing

## ❓ FAQ
- **What is ATAK-Maps?** A set of XML files to import maps into ATAK that allow the user to view various online map sources.
- **Can I cache these maps?** Yes, once you import the maps into ATAK, you can cache them for offline use.
- **Will you add more maps?** Yes, we are always looking for new maps to add. If you have a map suggestion, please open an issue.
We welcome your contributions! Review our [contribution guidelines](CONTRIBUTING.md) for more information.

## ⚠️ Open Street Maps Compatibility
Open Street Maps may block ATAK client access. These files are included for reference, and we are seeking a solution.
## Support

## 🤝 Contributing
Contributions are welcome. See our [contribution guidelines](CONTRIBUTING.md).
Join our [Discord server](https://discord.gg/dQUYADMW87) for support and community engagement.

## 📞 Support
For support, join our [Discord server](https://discord.gg/dQUYADMW87).
## License

## 📄 License
ATAK-Maps is under the [MIT License](LICENSE).
ATAK-Maps is distributed under the [MIT License](LICENSE).

0 comments on commit ee1ec14

Please sign in to comment.