diff --git a/pages/common/cargo-init.md b/pages/common/cargo-init.md new file mode 100644 index 000000000..f5af6bb53 --- /dev/null +++ b/pages/common/cargo-init.md @@ -0,0 +1,25 @@ +# cargo init + +> Create a new Cargo package. +> Equivalent of `cargo new`, but specifiying a directory is optional. +> More information: . + +- Initialize a Rust project with a binary target in the current directory: + +`cargo init` + +- Initialize a Rust project with a binary target in the specified directory: + +`cargo init {{path/to/directory}}` + +- Initialize a Rust project with a library target in the current directory: + +`cargo init --lib` + +- Initialize a version control system repository in the project directory (default: `git`): + +`cargo init --vcs {{git|hg|pijul|fossil|none}}` + +- Set the package name (default: directory name): + +`cargo init --name {{name}}` diff --git a/pages/common/cargo-new.md b/pages/common/cargo-new.md new file mode 100644 index 000000000..e46ad0a04 --- /dev/null +++ b/pages/common/cargo-new.md @@ -0,0 +1,9 @@ +# cargo new + +> Create a new Cargo package. +> Equivalent of `cargo init`, but specifiying a directory is required. +> More information: . + +- Create a new Rust project with a binary target: + +`cargo new {{path/to/directory}}` diff --git a/pages/common/cargo.md b/pages/common/cargo.md index eed134495..703851754 100644 --- a/pages/common/cargo.md +++ b/pages/common/cargo.md @@ -1,37 +1,37 @@ # cargo > Manage Rust projects and their module dependencies (crates). -> Some subcommands such as `cargo build` have their own usage documentation. +> Some subcommands such as `build` have their own usage documentation. > More information: . - Search for crates: `cargo search {{search_string}}` -- Install a crate: +- Install a binary crate: `cargo install {{crate_name}}` -- List installed crates: +- List installed binary crates: `cargo install --list` -- Create a new binary or library Rust project in the current directory: +- Create a new binary or library Rust project in the specified directory (or the current working directory by default): -`cargo init --{{bin|lib}}` +`cargo init --{{bin|lib}} {{path/to/directory}}` -- Create a new binary or library Rust project in the specified directory: +- Add a dependency to `Cargo.toml` in the current directory: -`cargo new {{path/to/directory}} --{{bin|lib}}` +`cargo add {{dependency}}` -- Build the Rust project in the current directory: +- Build the Rust project in the current directory using the release profile: -`cargo build` +`cargo build --release` -- Build the rust project in the current directory using the nightly compiler: +- Build the Rust project in the current directory using the nightly compiler (requires `rustup`): `cargo +nightly build` -- Build using a specific number of threads (default is the number of CPU cores): +- Build using a specific number of threads (default is the number of logical CPUs): `cargo build --jobs {{number_of_threads}}`