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://travis-ci.com/rust-lang/cargo.svg?branch=master)](https://travis-ci.com/rust-lang/cargo)
  10 [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang/cargo?branch=master&svg=true)](https://ci.appveyor.com/project/rust-lang-libs/cargo)
  11
  12 Code documentation: https://docs.rs/cargo/
  13
  14 ## Installing Cargo
  15
  16 Cargo is distributed by default with Rust, so if you've got `rustc` installed
  17 locally you probably also have `cargo` installed locally.
  18
  19 ## Compiling from Source
  20
  21 Cargo requires the following tools and packages to build:
  22
  23 * `git`
  24 * `python`
  25 * `curl` (on Unix)
  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 High level release notes are available as part of [Rust's release notes][rel].
  54 Cargo releases coincide with Rust releases.
  55
  56 [rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
  57
  58 ## Reporting issues
  59
  60 Found a bug? We'd love to know about it!
  61
  62 Please report all issues on the GitHub [issue tracker][issues].
  63
  64 [issues]: https://github.com/rust-lang/cargo/issues
  65
  66 ## Contributing
  67
  68 See [CONTRIBUTING.md](CONTRIBUTING.md). You may also find the architecture
  69 documentation useful ([ARCHITECTURE.md](ARCHITECTURE.md)).
  70
  71 ## License
  72
  73 Cargo is primarily distributed under the terms of both the MIT license
  74 and the Apache License (Version 2.0).
  75
  76 See LICENSE-APACHE and LICENSE-MIT for details.
  77
  78 ### Third party software
  79
  80 This product includes software developed by the OpenSSL Project
  81 for use in the OpenSSL Toolkit (https://www.openssl.org/).
  82
  83 In binary form, this product includes software that is licensed under the
  84 terms of the GNU General Public License, version 2, with a linking exception,
  85 which can be obtained from the [upstream repository][1].
  86
  87 See LICENSE-THIRD-PARTY for details.
  88
  89 [1]: https://github.com/libgit2/libgit2
  90