From 1f60a4b2d28f9b341317dc9237f8fd208187b5f1 Mon Sep 17 00:00:00 2001 From: upupnoah Date: Sat, 13 Jul 2024 07:05:03 +0700 Subject: [PATCH] feat: update readme and cargo.toml --- Cargo.toml | 1 + README.md | 31 ++++++++++++++++++------------- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0764549..04dcbcd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ name = "template" # enter your project name version = "0.1.0" edition = "2021" +authors = ["Noah "] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md index 9418718..017f0c3 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ cargo generate is a tool for generating project templates. It can use an existin ```bash cargo install cargo-generate ``` + The new project will use the `upupnoah/rust-template` template to generate basic code:： ```bash @@ -86,6 +87,7 @@ cargo install cargo-nextest --locked 1. cargo generate rust-noah/rust-template 2. Enter the directory, modify the cliff.toml file, change the URL after replace= to your own repository address (you need to create a repository first) + 1. Create an empty repository on GitHub (excluding README, .gitignore, and LICENSE). 2. cd new-project-dir (Name of the new project) 3. Execute the command in the empty project created in step 1 (git remote add ...) @@ -95,18 +97,21 @@ cargo install cargo-nextest --locked 4. Change the package.name in the Cargo.toml file to the name of the new project. Note: + - If git commit encounters problems, please delete `deny.toml` and then execute `cargo deny init` + - Add the code below to licenses. - ```toml - unlicensed = "allow" - allow = [ - "MIT", - "Apache-2.0", - "Unicode-DFS-2016", - "MPL-2.0", - "BSD-2-Clause", - "BSD-3-Clause", - "ISC", - "CC0-1.0", - ] - ``` + + ```toml + unlicensed = "allow" + allow = [ + "MIT", + "Apache-2.0", + "Unicode-DFS-2016", + "MPL-2.0", + "BSD-2-Clause", + "BSD-3-Clause", + "ISC", + "CC0-1.0", + ] + ```