c:geo 项目技术文档

1. 安装指南

1.1 获取源码

首先，你需要从GitHub上fork c:geo 项目的源码。不要直接克隆主仓库，而是要fork到你自己的仓库中。然后，你可以克隆你fork后的仓库到本地进行开发。

1.2 设置IDE

c:geo 项目使用 Android Studio 作为开发环境。你可以参考项目wiki中的IDE设置指南来配置你的开发环境。

1.3 安装依赖

在开始构建项目之前，你需要安装以下依赖：

• Android SDK：包括Google APIs（至少V26）、Google 仓库和Android支持仓库。
• Google USB Driver（仅限Windows用户）：用于在智能手机上安装应用程序。

1.4 API 密钥

为了完整使用c:geo的功能，你需要获取一些API密钥，包括Google Maps和OpenCaching网站的密钥。你可以参考项目wiki中的API密钥获取指南来获取这些密钥。

1.5 构建项目

使用 gradlew 命令从项目根目录运行构建脚本。你可以使用 gradlew assembleBasicDebug 来开始构建。

2. 项目的使用说明

2.1 功能概述

c:geo 是一个开源的、功能齐全的、随时可用的非官方 geocaching.com 客户端。它还支持其他地理藏宝平台的基本功能。无需网页浏览器或导出，只需下载并直接使用。

2.2 贡献指南

如果你想为项目贡献代码，请先在issue tracker中告诉我们你的想法。项目中有一些适合新手的good first issues，你可以从这些任务开始。

3. 项目API使用文档

3.1 Google Maps API

为了使用Google Maps功能，你需要获取Google Maps API v2密钥。你可以参考Google Maps SDK for Android: Get an API Key来获取密钥。

3.2 OpenCaching API

c:geo 支持多个OpenCaching网站，你需要为每个网站获取相应的API密钥。你可以参考项目wiki中的OpenCaching API密钥获取指南来获取这些密钥。

4. 项目安装方式

4.1 使用Android Studio

在Android Studio中，你可以通过“Build” => “Make Project”来构建项目。构建成功后，你可以通过“Run” => “Run”将应用部署到设备或模拟器上进行测试。

4.2 使用命令行

你也可以通过命令行使用 gradlew assembleBasicDebug 来构建项目，并生成可安装的APK文件。

4.3 测试

项目的测试类位于 test 目录下。你可以通过Android Studio的“Run”菜单来运行或调试这些测试类。确保在模拟器或设备上配置了有效的geocaching.com账户，以便所有测试能够成功运行。

5. 许可证

c:geo 项目遵循 Apache License, Version 2.0 许可证。

6. 联系信息

• 网站: https://www.cgeo.org/
• 支持: [e-mail]
• Twitter: https://twitter.com/android_gc
• Facebook: https://www.facebook.com/android.geocaching
• Google Play: https://play.google.com/store/apps/details?id=cgeo.geocaching
• 实时状态: https://status.cgeo.org/