Pārlūkot izejas kodu

Add usage guide

stacie 1 mēnesi atpakaļ
vecāks
revīzija
d13dd54f96
1 mainītis faili ar 102 papildinājumiem un 0 dzēšanām
  1. 102 0
      README.md

+ 102 - 0
README.md

@@ -0,0 +1,102 @@
+# 纯粹星辰名片生成 Skill
+
+这是杭州纯粹星辰人工智能科技有限公司(Less and Cosmos)的 Codex 名片生成 Skill,用于根据员工姓名、职位、邮箱和电话,快速制作符合品牌规范的双面名片。
+
+Skill 已包含品牌版式、Logo、公司地址、网站、理念文案、印刷规格及自动生成脚本,并已通过实际生成与结构校验。
+
+## 在 Codex 中使用
+
+安装 Skill 后,在 Codex 中输入:
+
+```text
+使用 $create-less-and-cosmos-business-card,制作名片:姓名张三,职位市场总监,邮箱 xxx@lessncosmos.com,电话 138 0000 0000。
+```
+
+也可以直接用自然语言提供以下四项信息:
+
+- 姓名
+- 职位(可以包含英文缩写,例如“联合创始人 / CMO”)
+- 邮箱
+- 手机号码
+
+例如:
+
+```text
+使用 $create-less-and-cosmos-business-card,制作名片:
+姓名:李明
+职位:产品总监 / CPO
+邮箱:liming@lessncosmos.com
+电话:139 1234 5678
+```
+
+Codex 会使用内置模板生成名片正反面、浏览器预览和结构化数据,并检查文字、版式和输出结构。国内手机号未填写国家代码时,会自动添加 `+86`。
+
+## 安装 Skill
+
+### 方法一:复制到 Codex Skills 目录
+
+1. 下载或克隆本仓库:
+
+   ```bash
+   git clone https://git.ccdw.xyz/stacie/ccxc-branding.git
+   cd ccxc-branding
+   ```
+
+2. 将 Skill 文件夹复制到 Codex 的个人 Skills 目录:
+
+   ```bash
+   mkdir -p ~/.codex/skills
+   cp -R create-less-and-cosmos-business-card ~/.codex/skills/
+   ```
+
+3. 重新启动 Codex,或打开一个新任务,让 Codex 重新加载 Skills。
+
+4. 在 Codex 中输入上面的示例指令即可生成名片。
+
+如果 `CODEX_HOME` 使用了自定义目录,请将文件夹复制到 `$CODEX_HOME/skills/`。
+
+## 命令行生成
+
+除了在 Codex 中调用,也可以直接运行内置脚本:
+
+```bash
+cd create-less-and-cosmos-business-card
+
+python3 scripts/generate_card.py \
+  --name "张三" \
+  --title "市场总监" \
+  --email "xxx@lessncosmos.com" \
+  --phone "138 0000 0000" \
+  --output-dir "./output/zhang-san"
+```
+
+脚本只依赖 Python 3 标准库,不需要额外安装第三方包。
+
+生成目录中包含:
+
+- `front.svg`:统一的品牌正面
+- `back.svg`:带个人信息的背面
+- `preview.html`:名片正反面浏览器预览
+- `card-data.json`:标准化后的名片信息,便于核对和修改
+
+用浏览器打开 `preview.html` 即可预览。需要修改个人信息时,建议重新运行脚本生成,不要直接移动或替换 SVG 中已经定位的文字。
+
+## 输出与印刷说明
+
+- 成品尺寸:90 × 54 mm,横版
+- SVG 画布:1800 × 1080
+- 推荐 PNG 预览尺寸:1800 × 1080 px
+- 商业印刷建议:四周各增加 3 mm 出血
+- 推荐纸张:350 g/m² 暖白色无涂布纸,哑光、低光泽表面
+
+送印前请逐字确认姓名、职位、邮箱、手机号码、公司名称、地址、网站和理念文案。更完整的印刷要求见 [`references/print-specifications.md`](create-less-and-cosmos-business-card/references/print-specifications.md)。
+
+## 固定品牌信息
+
+除非品牌资料发生变更,以下内容由 Skill 自动保持一致:
+
+- 公司:杭州纯粹星辰人工智能科技有限公司
+- 地址:浙江省杭州市西湖区转塘街道云腾丝路中心5号楼商业208室
+- 网站:lessncosmos.com
+- 理念:构建能够持续学习与进化的企业级人工智能系统。
+