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 * `python`
  24 * `curl` (on Unix)
  25 * `pkg-config` (on Unix, used to figure out the `libssl` headers/libraries)
  26 * OpenSSL headers (only for Unix, this is the `libssl-dev` package on ubuntu)
  27 * `cargo` and `rustc`
  28
  29 First, you'll want to check out this repository
  30
  31 ```
  32 git clone https://github.com/rust-lang/cargo
  33 cd cargo
  34 ```
  35
  36 With `cargo` already installed, you can simply run:
  37
  38 ```
  39 cargo build --release
  40 ```
  41
  42 ## Adding new subcommands to Cargo
  43
  44 Cargo is designed to be extensible with new subcommands without having to modify
  45 Cargo itself. See [the Wiki page][third-party-subcommands] for more details and
  46 a list of known community-developed subcommands.
  47
  48 [third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands
  49
  50
  51 ## Releases
  52
  53 Cargo releases coincide with Rust releases.
  54 High level release notes are available as part of [Rust's release notes][rel].
  55 Detailed release notes are available in this repo at [CHANGELOG.md].
  56
  57 [rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
  58 [CHANGELOG.md]: CHANGELOG.md
  59
  60 ## Reporting issues
  61
  62 Found a bug? We'd love to know about it!
  63
  64 Please report all issues on the GitHub [issue tracker][issues].
  65
  66 [issues]: https://github.com/rust-lang/cargo/issues
  67
  68 ## Contributing
  69
  70 See [CONTRIBUTING.md](CONTRIBUTING.md). You may also find the architecture
  71 documentation useful ([ARCHITECTURE.md](ARCHITECTURE.md)).
  72
  73 ## License
  74
  75 Cargo is primarily distributed under the terms of both the MIT license
  76 and the Apache License (Version 2.0).
  77
  78 See LICENSE-APACHE and LICENSE-MIT for details.
  79
  80 ### Third party software
  81
  82 This product includes software developed by the OpenSSL Project
  83 for use in the OpenSSL Toolkit (https://www.openssl.org/).
  84
  85 In binary form, this product includes software that is licensed under the
  86 terms of the GNU General Public License, version 2, with a linking exception,
  87 which can be obtained from the [upstream repository][1].
  88
  89 See LICENSE-THIRD-PARTY for details.
  90
  91 [1]: https://github.com/libgit2/libgit2
  92