hhh

这是一个用于文件的十六进制编码/解码器，但它有一个解析器用于读取描述和生成二进制文件。有关详细信息，请参阅与源代码一起分发的书籍（在 doc 文件夹中）。

hhh 使用 语义版本控制。

您发现了一个错误吗？通过 hhh 问题跟踪器提交，并确保包含（1）发生的情况，（2）您 期望 发生的情况，（3）如何 重现 错误，以及（4）您使用的 版本。

安装

要本地安装 hhh，使用 cargo install。

$ cargo install hhh
    Updating crates.io index
  Downloaded hhh v1.0.0
  Downloaded 1 crate (94.1 KB) in 0.91s
  Installing hhh v1.0.0
    Finished release [optimized] target(s) in 16.28s

如果您从仓库的本地副本安装，则可以使用 cargo install --path=.。

在线文档

仅适用于主分支

• hhh 书籍
• hhh Rust API

本地文档

如果您已本地构建了文档，则此链接将带您访问。

• 本地 hhh 书籍
• 本地 hhh Rust API

构建

您需要安装 Rust 2021 版本来编译。编译应该相对简单。

$ cargo build

这将构建 hhh 可执行文件。

您可能需要查看 etc/build.sh 和 etc\build.ps1。这些是运行 "pre-commit" 流程的小脚本（bash 和 powershell）。

API 文档

如果您想生成文档，请运行 cargo doc --nodeps。

生成后，API 文档应从 target/doc/hhh/index.html 开始在本地提供。

安全

请使用问题跟踪器中问题描述字段下面的 "此问题是机密的..." 按钮提交敏感的安全问题。

代码应定期与已知的Rust安全警报进行核对。这可以通过以下命令完成：cargo audit。您可以使用以下命令安装它：cargo install cargo-audit。

考虑安装Trivy。这是一个漏洞扫描器。

贡献

有关向本项目贡献的信息，请参阅CONTRIBUTING。

如果您有兴趣贡献，请参阅Roadmap、TechDebt以及代码中的任何TODO或BUG注释，了解仍需完成的事项。其他人可能正在处理这些问题，所以请务必与项目保持联系。

版权

hhh 版权所有（c）2023 斯蒂西·普罗威尔（[email protected]）。保留所有权利。有关更多信息，请参阅版权和许可证文件。