README.md
1# Cargo
2
3Cargo downloads your Rust project’s dependencies and compiles your project.
4
5**To start using Cargo**, learn more at [The Cargo Book].
6
7**To start developing Cargo itself**, read the [Cargo Contributor Guide].
8
9[The Cargo Book]: https://doc.rust-lang.org/cargo/
10[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
11
12> The Cargo binary distributed through with Rust is maintained by the Cargo
13> team for use by the wider ecosystem.
14> For all other uses of this crate (as a binary or library) this is maintained
15> by the Cargo team, primarily for use by Cargo and not intended for external
16> use (except as a transitive dependency). This crate may make major changes to
17> its APIs.
18
19## Code Status
20
21[](https://github.com/rust-lang/cargo/actions/workflows/main.yml)
22
23Code documentation: <https://doc.rust-lang.org/nightly/nightly-rustc/cargo/>
24
25## Compiling from Source
26
27### Requirements
28
29Cargo requires the following tools and packages to build:
30
31* `cargo` and `rustc`
32* A C compiler [for your platform](https://github.com/rust-lang/cc-rs#compile-time-requirements)
33* `git` (to clone this repository)
34
35**Other requirements:**
36
37The following are optional based on your platform and needs.
38
39* `pkg-config` — This is used to help locate system packages, such as `libssl` headers/libraries. This may not be required in all cases, such as using vendored OpenSSL, or on Windows.
40* OpenSSL — Only needed on Unix-like systems and only if the `vendored-openssl` Cargo feature is not used.
41
42 This requires the development headers, which can be obtained from the `libssl-dev` package on Ubuntu or `openssl-devel` with apk or yum or the `openssl` package from Homebrew on macOS.
43
44 If using the `vendored-openssl` Cargo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL.
45 This may require additional tools such as `perl` and `make`.
46
47 On macOS, common installation directories from Homebrew, MacPorts, or pkgsrc will be checked. Otherwise it will fall back to `pkg-config`.
48
49 On Windows, the system-provided Schannel will be used instead.
50
51 LibreSSL is also supported.
52
53**Optional system libraries:**
54
55The build will automatically use vendored versions of the following libraries. However, if they are provided by the system and can be found with `pkg-config`, then the system libraries will be used instead:
56
57* [`libcurl`](https://curl.se/libcurl/) — Used for network transfers.
58* [`libgit2`](https://libgit2.org/) — Used for fetching git dependencies.
59* [`libssh2`](https://www.libssh2.org/) — Used for SSH access to git repositories.
60* [`libz`](https://zlib.net/) (aka zlib) — Used for data compression.
61
62It is recommended to use the vendored versions as they are the versions that are tested to work with Cargo.
63
64### Compiling
65
66First, you'll want to check out this repository
67
68```
69git clone https://github.com/rust-lang/cargo.git
70cd cargo
71```
72
73With `cargo` already installed, you can simply run:
74
75```
76cargo build --release
77```
78
79## Adding new subcommands to Cargo
80
81Cargo is designed to be extensible with new subcommands without having to modify
82Cargo itself. See [the Wiki page][third-party-subcommands] for more details and
83a list of known community-developed subcommands.
84
85[third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands
86
87
88## Releases
89
90Cargo releases coincide with Rust releases.
91High level release notes are available as part of [Rust's release notes][rel].
92Detailed release notes are available in this repo at [CHANGELOG.md].
93
94[rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
95[CHANGELOG.md]: CHANGELOG.md
96
97## Reporting issues
98
99Found a bug? We'd love to know about it!
100
101Please report all issues on the GitHub [issue tracker][issues].
102
103[issues]: https://github.com/rust-lang/cargo/issues
104
105## Contributing
106
107See the **[Cargo Contributor Guide]** for a complete introduction
108to contributing to Cargo.
109
110## License
111
112Cargo is primarily distributed under the terms of both the MIT license
113and the Apache License (Version 2.0).
114
115See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
116
117### Third party software
118
119This product includes software developed by the OpenSSL Project
120for use in the OpenSSL Toolkit (https://www.openssl.org/).
121
122In binary form, this product includes software that is licensed under the
123terms of the GNU General Public License, version 2, with a linking exception,
124which can be obtained from the [upstream repository][1].
125
126See [LICENSE-THIRD-PARTY](LICENSE-THIRD-PARTY) for details.
127
128[1]: https://github.com/libgit2/libgit2
129
130
){kind=link}