zr-readme

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Zenon Red README Creation

Zenon Red README 文件创建指南

Generate README files that match the exact structure and style of zenon-red repositories.

生成与zenon-red仓库结构和风格完全匹配的README文件。

Template

模板

Use the template at assets/readme-template.md as the base structure.

以assets/readme-template.md作为基础结构模板。

Section Order (Required)

章节顺序（必填）

Every README must follow this exact order:

Header - Centered
```
<div>
```
with logo image,
```
# Title
```
, and tagline paragraph
Why - Explain the purpose and context
Navigation - Centered
```
<p>
```
with links to key docs
Usage - Installation, requirements, and examples
Contributing - Reference to CONTRIBUTING.md
License - Reference to LICENSE file

所有README必须严格遵循以下顺序：

头部区域 - 包含居中
```
<div>
```
、logo图片、
```
# 标题
```
和标语段落
项目背景 - 说明项目目的和背景
导航链接 - 包含关键文档链接的居中
```
<p>
```
段落
使用说明 - 安装步骤、依赖要求和示例
贡献指南 - 引用CONTRIBUTING.md文件
许可证 - 引用LICENSE文件

Formatting Rules

格式规则

Header Section

头部区域

html

<div align="center">
<img width="128px" alt="{name} logo" src="./.github/{name}.png">

html

<div align="center">
<img width="128px" alt="{name} logo" src="./.github/{name}.png">

{Name}

<p align="center"> {tagline line 1}.<br/> {tagline line 2}.<br/> Built by Aliens. </p> </div> ```

Logo: 128px width, PNG in
```
.github/
```
folder
Exception: in special repos that already keep logos at root (for example
```
zenon-red/.github
```
), use the existing repository convention.
Title: Plain
```
#
```
heading, not markdown link
Tagline: 2-3 lines, always end with "Built by Aliens."

<p align="center"> {tagline line 1}.<br/> {tagline line 2}.<br/> Built by Aliens. </p> </div> ```

Logo：宽度128px，PNG格式，存放在
```
.github/
```
文件夹中
例外情况：对于已将logo存放在根目录的特殊仓库（例如
```
zenon-red/.github
```
），遵循现有仓库的约定。
标题：使用普通的
```
#
```
标题，不要使用markdown链接
标语：2-3行，结尾必须加上“Built by Aliens.”

Requirements Badge

依赖要求徽章

Centered with

<h3 align="center">REQUIREMENTS</h3>

and

<p align="center">

wrapper:

html

<h3 align="center">REQUIREMENTS</h3>

<p align="center">
  <a href="https://nodejs.org/" target="_blank">
    <img src="https://img.shields.io/badge/Node.js-%3E%3D22.0.0-339933?logo=nodedotjs&logoColor=white&style=for-the-badge" alt="Node.js">
  </a>
</p>

Badge format:

https://img.shields.io/badge/{Label}-{Version}-{Color}?logo={icon}&logoColor=white&style=for-the-badge

使用

<h3 align="center">REQUIREMENTS</h3>

和

<p align="center">

包裹并居中显示：

html

<h3 align="center">REQUIREMENTS</h3>

<p align="center">
  <a href="https://nodejs.org/" target="_blank">
    <img src="https://img.shields.io/badge/Node.js-%3E%3D22.0.0-339933?logo=nodedotjs&logoColor=white&style=for-the-badge" alt="Node.js">
  </a>
</p>

徽章格式：

https://img.shields.io/badge/{Label}-{Version}-{Color}?logo={icon}&logoColor=white&style=for-the-badge

Navigation Links

导航链接

Centered paragraph with middot separators:

html

<p align="center">
  <a href="./docs/getting-started.md">Getting Started</a> ·
  <a href="./docs/commands.md">Commands</a> ·
  <a href="./docs/other.md">Other</a>
</p>

使用居中段落和中点分隔符：

html

<p align="center">
  <a href="./docs/getting-started.md">Getting Started</a> ·
  <a href="./docs/commands.md">Commands</a> ·
  <a href="./docs/other.md">Other</a>
</p>

Code Blocks

代码块

Always use

bash

language tag. Use

prefix for command output examples:

markdown

```bash
$ probe task list
tasks[5]{id,title,status}:
  "1","Example task",OPEN
```

始终使用

bash

语言标签。命令输出示例使用

前缀：

markdown

```bash
$ probe task list
tasks[5]{id,title,status}:
  "1","Example task",OPEN
```

Subsections

子章节

Use

###

for subsections under

## Usage

. Common subsections:

Installation (with #### Node Package Manager, #### GitHub Releases)
First Steps (numbered list)
Querying/Usage examples
Next Step (links to SKILL.md)

在

## 使用说明

下使用

###

定义子章节。常见子章节包括：

安装（包含#### Node Package Manager、#### GitHub Releases）
入门步骤（编号列表）
查询/使用示例
下一步（链接到SKILL.md）

Contributing Section

贡献指南章节

Standard text referencing Nexus:

markdown

undefined

引用Nexus的标准文本：

markdown

undefined

Contributing

This project is intended to be maintained autonomously by agents in the future. Humans can contribute by routing changes through their agents via Nexus. See CONTRIBUTING.md for details.

undefined

This project is intended to be maintained autonomously by agents in the future. Humans can contribute by routing changes through their agents via Nexus. See CONTRIBUTING.md for details.

undefined

License Section

许可证章节

markdown

undefined

markdown

undefined

License

MIT

undefined

MIT

undefined

Process

流程

Gather repository info: name, description, tech stack, key features
Generate logo placeholder note if no expected logo path exists (usually
```
.github/{name}.png
```
)
Write each section following the template structure
Ensure all badges use
```
style=for-the-badge
```
Verify section order matches exactly

收集仓库信息：名称、描述、技术栈、核心功能
如果预期的logo路径（通常为
```
.github/{name}.png
```
）不存在，添加logo占位符说明
按照模板结构编写每个章节
确保所有徽章都使用
```
style=for-the-badge
```
验证章节顺序是否完全匹配

Badge Color Reference

徽章颜色参考

Node.js:
```
339933
```
(green)
Rust:
```
000000
```
(black)
Python:
```
3776AB
```
(blue)
TypeScript:
```
3178C6
```
(blue)
Go:
```
00ADD8
```
(cyan)

Node.js:
```
339933
```
（绿色）
Rust:
```
000000
```
（黑色）
Python:
```
3776AB
```
（蓝色）
TypeScript:
```
3178C6
```
（蓝色）
Go:
```
00ADD8
```
（青色）