]> git.proxmox.com Git - cargo.git/blame - README.md
auto merge of #631 : alexcrichton/cargo/issue-514, r=brson
[cargo.git] / README.md
CommitLineData
b4e86302
YK
1Cargo downloads your Rust project’s dependencies and compiles your project.
2
3Learn more at http://crates.io/.
4
1aaaf851 5## Installing cargo from nightlies
ffd985f1
AC
6
7Cargo has nightlies available for use. The cargo source is not always guaranteed
8to compile on rust master as it may lag behind by a day or two. Nightlies,
9however, will run regardless of this fact!
10
a39a331a
CD
11```sh
12triple=x86_64-unknown-linux-gnu
cce8d582 13curl -O https://static.rust-lang.org/cargo-dist/cargo-nightly-$triple.tar.gz
a39a331a
CD
14tar xf cargo-nightly-$triple.tar.gz
15./cargo-nightly-$triple/install.sh
ffd985f1
AC
16```
17
c1bbc721 18Nightlies are available for the following triples:
ffd985f1 19
cce8d582
BA
20* [`x86_64-unknown-linux-gnu`](https://static.rust-lang.org/cargo-dist/cargo-nightly-x86_64-unknown-linux-gnu.tar.gz)
21* [`i686-unknown-linux-gnu`](https://static.rust-lang.org/cargo-dist/cargo-nightly-i686-unknown-linux-gnu.tar.gz)
22* [`x86_64-apple-darwin`](https://static.rust-lang.org/cargo-dist/cargo-nightly-x86_64-apple-darwin.tar.gz)
23* [`i686-apple-darwin`](https://static.rust-lang.org/cargo-dist/cargo-nightly-i686-apple-darwin.tar.gz)
24* [`x86_64-w64-mingw32`](https://static.rust-lang.org/cargo-dist/cargo-nightly-x86_64-w64-mingw32.tar.gz)
25* [`i686-w64-mingw32`](https://static.rust-lang.org/cargo-dist/cargo-nightly-i686-w64-mingw32.tar.gz)
c1bbc721
AC
26
27Note that if you're using the windows snapshot you will need Mingw-w64 installed
28as well as MSYS. The installation script needs to be run inside the MSYS shell.
ffd985f1 29
41a4df26 30## Compiling cargo
31
5ef03758
AC
32Cargo requires the following tools and packages to build:
33
34* `rustc`
35* `python`
36* `curl` or `wget`
37* `cmake`
38* `pkg-config`
39* OpenSSL headers (`libssl-dev` package on ubuntu)
40
41Cargo can then be compiled like many other standard unix-like projects:
c1bbc721 42
a39a331a
CD
43```sh
44git clone https://github.com/rust-lang/cargo
45cd cargo
46./configure
47make
48make install
c1bbc721 49```
e2353a5b 50
c1bbc721
AC
51More options can be discovered through `./configure`, such as compiling cargo
52for more than one target. For example, if you'd like to compile both 32 and 64
53bit versions of cargo on unix you would use:
54
55```
3b77b2c7 56$ ./configure --target=i686-unknown-linux-gnu,x86_64-unknown-linux-gnu
c1bbc721 57```
41a4df26 58
fe624014
YK
59## Contributing to the Docs
60
2f86d742
EB
61To contribute to the docs, all you need to do is change the markdown files in
62the `src/doc` directory.
fe624014 63
c1bbc721
AC
64## Reporting Issues
65
66Found a bug? We'd love to know about it!
67
68Please report all issues on the github [issue tracker][issues].
69
70[issues]: https://github.com/rust-lang/cargo/issues
71
c6fc2f58
AC
72## License
73
74Cargo is primarily distributed under the terms of both the MIT license
75and the Apache License (Version 2.0).
76
77See LICENSE-APACHE and LICENSE-MIT for details.