From 9c336d2ab4bc4f375a8dd176c82384fe53ebedcf Mon Sep 17 00:00:00 2001 From: Evan Date: Sat, 14 Mar 2026 11:53:45 +0900 Subject: [PATCH] docs: remove Chinese sections, English only --- CONTRIBUTING.md | 19 ------------- README.md | 72 ------------------------------------------------- 2 files changed, 91 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9865eda..79103c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,22 +87,3 @@ Push your branch and open a PR. The PR template will guide you through the check - **One provider per file** -- don't mix providers in a single TOML file - **Keep aliases short** -- 1-3 word abbreviations that users would naturally type ---- - -# 贡献指南 - -感谢您帮助维护模型目录！以下是添加或更新模型条目的方法。 - -## 如何添加新模型 - -1. Fork 并克隆此仓库 -2. 在 `providers/` 目录中找到对应的提供商文件 -3. 添加 `[[models]]` 条目（参考上方英文模板） -4. 运行 `python scripts/validate.py` 验证 -5. 提交 Pull Request - -## 定价说明 - -- 所有价格均以 **美元/百万 tokens** 为单位 -- 免费模型和本地模型的价格为 `0.0` -- 请从官方定价页面获取准确数据 diff --git a/README.md b/README.md index f87c2a1..e5a6e48 100644 --- a/README.md +++ b/README.md @@ -114,75 +114,3 @@ This checks all TOML files for correctness: required fields, valid tiers, non-ne ## License MIT License. See [LICENSE](LICENSE). - ---- - -# LibreFang 模型目录 - -社区维护的 [LibreFang](https://github.com/librefang/librefang) 模型元数据目录 -- 开源 Agent 操作系统。 - -本仓库是模型元数据（定价、上下文窗口、能力标记）的唯一数据源。当新模型发布时（如 GPT-5.5、Claude 5），任何人都可以在这里提交 PR，而无需修改 LibreFang 二进制文件。 - -## 目录结构 - -``` -model-catalog/ -├── providers/ # 每个提供商一个 TOML 文件 -│ ├── anthropic.toml -│ ├── openai.toml -│ ├── gemini.toml -│ └── ... -├── aliases.toml # 全局别名映射（如 "sonnet" -> "claude-sonnet-4-6"） -├── schema.toml # 字段定义参考 -├── scripts/ -│ └── validate.py # 验证脚本 -├── CONTRIBUTING.md # 如何添加新模型 -└── LICENSE # MIT 许可证 -``` - -## LibreFang 如何使用此目录 - -LibreFang 内置了编译到二进制文件中的模型目录。本仓库作为上游数据源。更新本地目录： - -```bash -librefang catalog update -``` - -### 本地自定义模型 - -您也可以在本地添加自定义模型，无需提交 PR： - -```bash -# 编辑个人配置文件 -# ~/.librefang/model_catalog.toml - -[[models]] -id = "my-custom-model" -display_name = "我的自定义模型" -provider = "ollama" -tier = "local" -context_window = 32768 -max_output_tokens = 4096 -input_cost_per_m = 0.0 -output_cost_per_m = 0.0 -``` - -## 如何添加新模型 - -1. 编辑 `providers/` 中对应的提供商文件 -2. 运行验证：`python scripts/validate.py` -3. 提交 Pull Request - -详细说明请参考 [CONTRIBUTING.md](CONTRIBUTING.md)。 - -## 验证 - -```bash -python scripts/validate.py -``` - -检查所有 TOML 文件的正确性：必填字段、有效的层级值、非负成本、无重复 ID。 - -## 许可证 - -MIT 许可证。详见 [LICENSE](LICENSE)。