标准 Readme

生成与标准 Readme 兼容的 README 文件

标准 Readme 是由 @RichardLitt 创建的标准 README 编写风格。他自己实现了一个用于创建标准化 README 的 Yeoman 生成器，就像这个一样。这个工具深受 Richard 的生成器 启发。我只是想编写一个可以作为单个静态链接二进制文件分发的实现。这个实现支持原始版本的所有功能，并应生成几乎相同的 README 文件。

有关标准 Readme 的更多信息，请参阅 标准 Readme 仓库。

目录

• 安装
• 用法
• 发布 standard-readme
• 维护者
• 贡献
• 许可证

安装

您可以使用 download.ps1 脚本下载适用于您的操作系统和架构的正确版本。别被名字骗了，这个脚本在 Linux 或 macOS 的 Bash/ZSH 上也可以工作！

在 Linux 或 macOS 上运行

curl -s https://raw.githubusercontent.com/kfkonrad/generator-standard-readme-rust/main/download.ps1 | bash
# OR
wget -qO- https://raw.githubusercontent.com/kfkonrad/generator-standard-readme-rust/main/download.ps1 | bash

在 Windows 上运行

Invoke-Expression ((Invoke-WebRequest -Uri "https://raw.githubusercontent.com/kfkonrad/generator-standard-readme-rust/main/download.ps1").Content)

如果您不喜欢从互联网运行脚本，您也可以在这个仓库的 版本部分 中找到和下载应用程序。

您还可以使用 cargo 从源代码安装

cargo install standard-readme

用法

只需运行 standard-readme

standard-readme

您将交互式地输入生成 README 文件所需的任何附加信息。

发布 standard-readme

要发布 standard-readme 的新版本到 crates.io，您可以像其他 Rust 项目一样运行 cargo publish 命令（假设您有足够的权限访问该包）。

要发布 standard-readme 的新版本作为 GitHub 发布，您可以运行 ./release.sh（再次假设您有足够的权限）。release.sh 脚本执行多个步骤

1. 如果需要，安装 cross 和 git-cliff
2. 检查 GitHub CLI gh
3. 如果运行在 macOS 上：如果需要，安装 rustup 目标 aarch64-apple-darwin 和 x86_64-apple-darwin
4. 为所有配置的目标编译 standard-readme。仅在Mac上运行时才会创建macOS二进制文件。Linux和Windows的二进制文件使用cross进行交叉编译
5. 压缩并收集每个平台的二进制文件
6. 基于在 Cargo.toml 中找到的版本创建和推送git标签
7. 为该版本创建GitHub发行版。变更日志使用 git-cliff 生成，压缩的二进制文件将自动上传

release.sh 会检测到脏的git状态（例如未暂存或未提交的更改）并跳过创建标签或发行版。

它还支持dry-run模式，该模式执行所有构建但跳过git标签和GitHub发行版步骤。要执行dry-run，请执行 ./release.sh --dry-run。这是唯一支持的参数，所有其他参数都将被忽略。

release.sh 与所有工具的BSD和GNU变体兼容。除了Rust工具链外，还需要安装GitHub CLI gh 才能使 release.sh 运行。

维护者

@kfkonrad

贡献

接受PRs。

小贴士：如果编辑README，请遵循standard-readme规范。

许可证

MIT © 2024 Kevin F. Konrad