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

chore: clarify build and run steps #188

Merged
merged 1 commit into from
May 4, 2022
Merged

Conversation

CBenoit
Copy link
Contributor

@CBenoit CBenoit commented May 4, 2022

Summary

cargo update is not required to "install the dependencies". In fact, this command is meant to update the Cargo.lock.
https://doc.rust-lang.org/cargo/commands/cargo-update.html

cargo run implies cargo build (and to run in release mode, --release must be provided to the run command too).

Feel free to close if you prefer the way it currently is.

Preflight checklist

  • Code formatted with rustfmt
  • Relevant tests added
  • Any new documentation added

@CBenoit CBenoit changed the title Clarify build and run steps in README.md chore: clarify build and run steps May 4, 2022
`cargo update` is not required to "install the dependencies". In fact, this command is meant to _update the Cargo.lock_.
https://doc.rust-lang.org/cargo/commands/cargo-update.html

`cargo run` implies `cargo build` (and to run in release mode, `--release` must be provided to the run command too).
@mike-engel mike-engel merged commit e55e8cd into mike-engel:main May 4, 2022
@mike-engel
Copy link
Owner

Thanks @CBenoit! That's a very old part of the README, so I probably didn't understand everything that well when I wrote it 😄

@CBenoit CBenoit deleted the patch-1 branch May 4, 2022 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants