首页
/ OctoDroid 技术文档

OctoDroid 技术文档

2024-12-24 11:32:34作者:彭桢灵Jeremy

1. 安装指南

下载安装

  • Google Play: Get it on Google Play 在 Google Play 商店搜索并下载 OctoDroid。
  • F-Droid: Get it on F-Droid 在 F-Droid 商店搜索并下载 OctoDroid。

手动构建

  1. 确保已安装 Android SDK 平台和构建工具。
  2. 在您的 GitHub 设置 下为 OctoDroid 注册一个应用程序:
    • 名称自定。
    • 回调 URL 必须为 gh4a://oauth
  3. 创建一个 client.properties 文件,内容如下:
    ClientId="<CLIENT ID DISPLAYED IN APPLICATION SETTINGS>"
    ClientSecret="<CLIENT SECRET DISPLAYED IN APPLICATION SETTINGS>"
    
  4. 使用 Gradle 构建:
    ./gradlew assembleDebug
    
  5. 要获取可用任务的完整列表:
    ./gradlew tasks
    

2. 项目的使用说明

主要功能

  • 仓库: 列出仓库、关注/取消关注仓库、查看分支/标签、拉取请求、贡献者、观察者/网络、问题。
  • 用户: 查看基本信息、动态、关注/取消关注用户、查看公开/关注的仓库、粉丝/关注者、组织(如果类型为用户)、成员(如果类型为组织)。
  • 问题: 列出问题、按标签/指派人/里程碑过滤、创建/编辑/关闭/重新打开问题、评论问题、管理标签、管理里程碑。
  • 提交: 查看提交(显示更改/添加/删除的文件)、带颜色高亮的 HTML 差异查看器、在每个文件上查看提交历史。
  • 树/文件浏览器: 浏览源代码、带有语法高亮的代码查看。
  • Gist: 列出公共 Gist、查看 Gist 内容。
  • 探索 GitHub: 公共时间线、趋势仓库(今日、本周、本月、永远)、GitHub 博客。

3. 项目API使用文档

OctoDroid 使用 GitHub API 实现功能。具体 API 使用方法和参数请参考 GitHub 官方 API 文档。以下是一些常用 API 的简要说明:

  • 仓库: /user/repos/repos/{owner}/{repo}/watchers/repos/{owner}/{repo}/branches 等。
  • 用户: /users/{username}/user/following/{target_user}/user/followers 等。
  • 问题: /repos/{owner}/{repo}/issues/repos/{owner}/{repo}/issues/{number} 等。
  • 提交: /repos/{owner}/{repo}/commits/repos/{owner}/{repo}/commits/{sha} 等。

4. 项目安装方式

请参考上述“安装指南”部分,通过 Google Play、F-Droid 或手动构建的方式安装 OctoDroid。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起