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 Code documentation: https://docs.rs/cargo/
  10
  11 ## Installing Cargo
  12
  13 Cargo is distributed by default with Rust, so if you've got `rustc` installed
  14 locally you probably also have `cargo` installed locally.
  15
  16 ## Compiling from Source
  17
  18 Cargo requires the following tools and packages to build:
  19
  20 * `git`
  21 * `curl` (on Unix)
  22 * `pkg-config` (on Unix, used to figure out the `libssl` headers/libraries)
  23 * OpenSSL headers (only for Unix, this is the `libssl-dev` package on ubuntu)
  24 * `cargo` and `rustc`
  25
  26 First, you'll want to check out this repository
  27
  28 ```
  29 git clone https://github.com/rust-lang/cargo
  30 cd cargo
  31 ```
  32
  33 With `cargo` already installed, you can simply run:
  34
  35 ```
  36 cargo build --release
  37 ```
  38
  39 ## Adding new subcommands to Cargo
  40
  41 Cargo is designed to be extensible with new subcommands without having to modify
  42 Cargo itself. See [the Wiki page][third-party-subcommands] for more details and
  43 a list of known community-developed subcommands.
  44
  45 [third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands
  46
  47
  48 ## Releases
  49
  50 Cargo releases coincide with Rust releases.
  51 High level release notes are available as part of [Rust's release notes][rel].
  52 Detailed release notes are available in this repo at [CHANGELOG.md].
  53
  54 [rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
  55 [CHANGELOG.md]: CHANGELOG.md
  56
  57 ## Reporting issues
  58
  59 Found a bug? We'd love to know about it!
  60
  61 Please report all issues on the GitHub [issue tracker][issues].
  62
  63 [issues]: https://github.com/rust-lang/cargo/issues
  64
  65 ## Contributing
  66
  67 See the **[Cargo Contributor Guide]** for a complete introduction
  68 to contributing to Cargo.
  69
  70 [Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
  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](LICENSE-APACHE) and [LICENSE-MIT](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](LICENSE-THIRD-PARTY) for details.
  89
  90 [1]: https://github.com/libgit2/libgit2
  91