新 Rust 项目

该项目是 Erich 的个人 Rust 入门套件，用于开发新的库和二进制文件。你不应该在除他的 new-rust-project 仓库以外的任何地方看到这个。

概述

在某个时候，Erich 烦于积累很多他知道自己会忘记的用于启动 Rust 项目的有趣信息。所以他终于坐下来制作了这个仓库。使用示例

#! /bin/sh

git clone --shallow https://github.com/ErichDonGubler/new-rust-project name-of-new-rust-project
cd name-of-new-rust-project
rm -rf .git
git init
git add .
git commit -m "Initial commit"
git remote add origin [email protected]:ErichDonGubler/name-of-new-rust-project
git push -u origin master

功能

许可协议

此模板默认使用 MPL 2.0。Erich 在这里默认使用 MPL 的原因是

• 非常宽松的许可协议
• 对突然起飞的项目的专利保护
• 不那么讨厌的左派

当不确定时，请记住 Erich 不是律师。将您的项目改为使用您认为合适的协议。

贡献

欢迎贡献、功能请求和错误报告！请参阅 贡献指南 以开始。

《行为准则》使用 Contributor Covenant v1.4.1。如果此版本有更新的版本，请随时提交 PR！

README 中的 Crate 文档

Crate 文档内嵌在此 README 中。这意味着您将免费获得文档测试！通过阅读 README 来试用它——它使用 cargo-sync-readme。此外，它已集成到 CI 中，所以您不会忘记它！

println!("This should run just fine.");

panic!("This should panic.");

!@#$% // This should fail to compile.

文档的智能默认设置

默认使用 Rust Playground 作为游乐场服务。

cargo-release 配置

cargo-release 已配置以保持模板与版本发布的同步，并且有一些 Erich 认为更合理的默认设置。

更改日志

是的，你应该维护一个 CHANGELOG。 ;)

更激进的代码检查和测试

已启用 Erich 偏爱的几个 rustc 和 clippy 代码检查。请参阅 src/lib.rs 的顶部以获取完整列表。

在文档测试和发布模式下拒绝警告。

开箱即用的 CI

相关的CI配置（Travis在.travis.yml中）测试

• 在Linux、Windows和MacOS上运行测试。
• 使用cargo clippy执行完整的一套lints。
• 使用cargo fmt进行格式化。
• 使用cargo test执行内置的完整测试套件。

按钮！

README顶部的按钮种类繁多。这些按钮旨在鼓励维护者和新用户的活动。一些按钮可能不适合内部或私有项目，因为这些项目实际上不会在crates.io上发布。鼓励您保留想要的按钮，丢弃不需要的。