Skip to content

github_upload_tutorial.md

Latest commit

 

History

History
149 lines (106 loc) · 2.99 KB

github_upload_tutorial.md

File metadata and controls

149 lines (106 loc) · 2.99 KB

reading_easy 上传到 GitHub 教程

这份教程用于把 reading-easy/ 发布成一个 GitHub 开源项目。教程默认你已经在本地完成了 reading-easy/ 目录和打包产物。

1. 检查发布目录

在项目根目录执行：

Get-ChildItem reading-easy
Get-ChildItem dist

你应该能看到：

reading-easy/
  .codex-plugin/
  skills/
  docs/
  assets/
  README.md

dist/
  reading-easy-codex-plugin.zip
  reading-easy-claude-skill.zip

2. 初始化 Git 仓库

如果你只想发布 reading-easy/，可以进入该目录：

Set-Location reading-easy
git init
git add .
git commit -m "feat: release reading_easy academic research skill"

如果你想把整个 workspace 都放到一个仓库，请在上一级目录初始化 Git，并确认不要提交个人隐私文件。

3. 在 GitHub 创建仓库

  1. 打开 GitHub。
  2. 点击右上角 +。
  3. 选择 New repository。
  4. Repository name 建议使用：
reading-easy
  1. Description 可以写：
A dual-platform Codex and Claude Code skill for academic paper reading, literature review, weekly research updates, and Zotero-Obsidian notes.
  1. 不要勾选自动创建 README，因为本地已经有 README。
  2. 创建仓库。

4. 连接远程仓库并推送

把 <your-account> 替换为你的 GitHub 用户名：

git branch -M main
git remote add origin https://github.com/<your-account>/reading-easy.git
git push -u origin main

如果提示远程仓库已存在 README 或历史记录，可以先确认远程内容是否需要保留，不要直接强推覆盖。

5. 上传 Release 包

在 GitHub 仓库页面：

  1. 点击右侧或顶部的 Releases。
  2. 点击 Draft a new release。
  3. Tag version 填：
v0.1.0
  1. Release title 填：
reading_easy v0.1.0
  1. 描述可以写：
Initial release of reading_easy.

- Codex plugin package
- Claude Code skill package
- Paper deep note, survey writer, research digest, weekly research update, and Zotero-Obsidian workflow
- Promotional screenshots and Xiaohongshu post draft
  1. 上传两个 zip：
dist/reading-easy-codex-plugin.zip
dist/reading-easy-claude-skill.zip
  1. 点击 Publish release。

6. README 发布前检查

发布前建议检查：

  • README 是否说明这是辅助阅读和整理，不是代写论文。
  • 是否明确当前不实现真实 API、爬虫、Zotero 写入或 Obsidian 插件。
  • assets/promo/ 下的截图是否能在 GitHub 页面正常显示。
  • 示例是否匿名，不包含个人研究数据或未公开论文内容。

7. 后续更新流程

每次更新后：

git status
git add .
git commit -m "docs: update reading_easy documentation"
git push

如果更新了 zip 包，建议发布新的 release：

v0.1.1, v0.2.0, ...

8. 推荐仓库 Topics

codex
claude-code
academic-writing
paper-reading
literature-review
zotero
obsidian
research-workflow