Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update readme and cargo.toml #3

Merged
merged 1 commit into from
Jul 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "template" # enter your project name
version = "0.1.0"
edition = "2021"
authors = ["Noah <upupqi.cs@gmail.com>"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 ...)
Expand All @@ -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",
]
```