]> git.proxmox.com Git - cargo.git/blob - README.md
Update contributing documentation for running tests and building docs.
[cargo.git] / README.md
1 # Cargo
2
3 Cargo downloads your Rust project’s dependencies and compiles your project.
4
5 Learn more at https://doc.rust-lang.org/cargo/
6
7 ## Code Status
8
9 [![Build Status](https://dev.azure.com/rust-lang/cargo/_apis/build/status/rust-lang.cargo?branchName=auto-cargo)](https://dev.azure.com/rust-lang/cargo/_build?definitionId=18)
10
11 Code documentation: https://docs.rs/cargo/
12
13 ## Installing Cargo
14
15 Cargo is distributed by default with Rust, so if you've got `rustc` installed
16 locally you probably also have `cargo` installed locally.
17
18 ## Compiling from Source
19
20 Cargo requires the following tools and packages to build:
21
22 * `git`
23 * `curl` (on Unix)
24 * `pkg-config` (on Unix, used to figure out the `libssl` headers/libraries)
25 * OpenSSL headers (only for Unix, this is the `libssl-dev` package on ubuntu)
26 * `cargo` and `rustc`
27
28 First, you'll want to check out this repository
29
30 ```
31 git clone https://github.com/rust-lang/cargo
32 cd cargo
33 ```
34
35 With `cargo` already installed, you can simply run:
36
37 ```
38 cargo build --release
39 ```
40
41 ## Adding new subcommands to Cargo
42
43 Cargo is designed to be extensible with new subcommands without having to modify
44 Cargo itself. See [the Wiki page][third-party-subcommands] for more details and
45 a list of known community-developed subcommands.
46
47 [third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands
48
49
50 ## Releases
51
52 Cargo releases coincide with Rust releases.
53 High level release notes are available as part of [Rust's release notes][rel].
54 Detailed release notes are available in this repo at [CHANGELOG.md].
55
56 [rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
57 [CHANGELOG.md]: CHANGELOG.md
58
59 ## Reporting issues
60
61 Found a bug? We'd love to know about it!
62
63 Please report all issues on the GitHub [issue tracker][issues].
64
65 [issues]: https://github.com/rust-lang/cargo/issues
66
67 ## Contributing
68
69 See [CONTRIBUTING.md](CONTRIBUTING.md). You may also find the architecture
70 documentation useful ([ARCHITECTURE.md](ARCHITECTURE.md)).
71
72 ## License
73
74 Cargo is primarily distributed under the terms of both the MIT license
75 and the Apache License (Version 2.0).
76
77 See LICENSE-APACHE and LICENSE-MIT for details.
78
79 ### Third party software
80
81 This product includes software developed by the OpenSSL Project
82 for use in the OpenSSL Toolkit (https://www.openssl.org/).
83
84 In binary form, this product includes software that is licensed under the
85 terms of the GNU General Public License, version 2, with a linking exception,
86 which can be obtained from the [upstream repository][1].
87
88 See LICENSE-THIRD-PARTY for details.
89
90 [1]: https://github.com/libgit2/libgit2
91